rel 2023.1.4

Author: FredHappyface

CHANGELOG.md

@@ -3,6 +3,11 @@
 All major and minor version changes will be documented in this file. Details of
 patch-level version changes can be found in [commit messages](../../commits/master).
 
+## 2023.1.4 - 2023/06/26
+
+- Update format to output info and detected package license
+- Bump dep versions
+
 ## 2023.1.2 - 2023/06/24
 
 - Merge PR https://github.com/FHPythonUtils/LicenseCheck/pull/39 (Fixes #38)

documentation/reference/licensecheck/formatter.md

@@ -22,6 +22,7 @@ Format to ansi
 
 #### Arguments
 
+- `myLice` *License* - project license
 - `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
@@ -31,24 +32,26 @@ Format to ansi
 #### Signature
 
 ```python
-def ansi(packages: list[PackageInfo]) -> str:
+def ansi(myLice: License, packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
+- [License](./types.md#license)
 - [PackageInfo](./types.md#packageinfo)
 
 
 
 ## markdown
 
-[Show source in formatter.py:99](../../../licensecheck/formatter.py#L99)
+[Show source in formatter.py:109](../../../licensecheck/formatter.py#L109)
 
 Format to markdown
 
 #### Arguments
 
+- `myLice` *License* - project license
 - `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
@@ -58,24 +61,26 @@ Format to markdown
 #### Signature
 
 ```python
-def markdown(packages: list[PackageInfo]) -> str:
+def markdown(myLice: License, packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
+- [License](./types.md#license)
 - [PackageInfo](./types.md#packageinfo)
 
 
 
 ## plainText
 
-[Show source in formatter.py:87](../../../licensecheck/formatter.py#L87)
+[Show source in formatter.py:96](../../../licensecheck/formatter.py#L96)
 
-Format to plain text
+Format to ansi
 
 #### Arguments
 
+- `myLice` *License* - project license
 - `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
@@ -85,24 +90,26 @@ Format to plain text
 #### Signature
 
 ```python
-def plainText(packages: list[PackageInfo]) -> str:
+def plainText(myLice: License, packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
+- [License](./types.md#license)
 - [PackageInfo](./types.md#packageinfo)
 
 
 
 ## raw
 
-[Show source in formatter.py:134](../../../licensecheck/formatter.py#L134)
+[Show source in formatter.py:148](../../../licensecheck/formatter.py#L148)
 
-Format to raw json
+Format to json
 
 #### Arguments
 
+- `myLice` *License* - project license
 - `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
@@ -112,24 +119,26 @@ Format to raw json
 #### Signature
 
 ```python
-def raw(packages: list[PackageInfo]) -> str:
+def raw(myLice: License, packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
+- [License](./types.md#license)
 - [PackageInfo](./types.md#packageinfo)
 
 
 
 ## rawCsv
 
-[Show source in formatter.py:146](../../../licensecheck/formatter.py#L146)
+[Show source in formatter.py:168](../../../licensecheck/formatter.py#L168)
 
-Format to raw csv
+Format to csv
 
 #### Arguments
 
+- `myLice` *License* - project license
 - `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
@@ -139,12 +148,13 @@ Format to raw csv
 #### Signature
 
 ```python
-def rawCsv(packages: list[PackageInfo]) -> str:
+def rawCsv(myLice: License, packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
+- [License](./types.md#license)
 - [PackageInfo](./types.md#packageinfo)
 
 

documentation/reference/licensecheck/get_deps.md

@@ -26,7 +26,9 @@ Get a set of dependencies with licenses and determine license compatibility.
 
 #### Returns
 
-- `set[PackageInfo]` - set of updated dependencies with licenseCompat set
+- `tuple[License,` *set[PackageInfo]]* - tuple of
+ my package license
+ set of updated dependencies with licenseCompat set
 
 #### Signature
 
@@ -37,12 +39,13 @@ def getDepsWithLicenses(
     failPackages: list[str],
     ignoreLicenses: list[str],
     failLicenses: list[str],
-) -> set[PackageInfo]:
+) -> tuple[License, set[PackageInfo]]:
     ...
 ```
 
 #### See also
 
+- [License](./types.md#license)
 - [PackageInfo](./types.md#packageinfo)
 
 

documentation/reference/licensecheck/types.md

@@ -9,6 +9,7 @@ Types
 - [Types](#types)
   - [License](#license)
   - [PackageInfo](#packageinfo)
+  - [printLicense](#printlicense)
 
 ## License
 
@@ -60,3 +61,31 @@ class PackageInfo:
 ```
 
 
+
+## printLicense
+
+[Show source in types.py:73](../../../licensecheck/types.py#L73)
+
+Output a license as plain text
+
+#### Arguments
+
+- `licenseEnum` *L* - License
+
+#### Returns
+
+Type: *str*
+license of plain text
+
+#### Signature
+
+```python
+def printLicense(licenseEnum: L) -> str:
+    ...
+```
+
+#### See also
+
+- [L](#l)
+
+

licensecheck/__init__.py

@@ -87,7 +87,7 @@ def cli() -> None:
 	)
 
 	# Get list of licenses
-	depsWithLicenses = get_deps.getDepsWithLicenses(
+	myLice, depsWithLicenses = get_deps.getDepsWithLicenses(
 		simpleConf.get("using", "poetry"),
 		simpleConf.get("ignore_packages", []),
 		simpleConf.get("fail_packages", []),
@@ -101,7 +101,7 @@ def cli() -> None:
 	# Format the results
 	if simpleConf.get("format", "simple") in formatter.formatMap:
 		print(
-			formatter.formatMap[simpleConf.get("format", "simple")](sorted(depsWithLicenses)),
+			formatter.formatMap[simpleConf.get("format", "simple")](myLice, sorted(depsWithLicenses)),
 			file=filename,
 		)
 	else:

licensecheck/formatter.py

@@ -31,9 +31,9 @@
 from rich.console import Console
 from rich.table import Table
 
-from licensecheck.types import PackageInfo
+from licensecheck.types import License, PackageInfo, printLicense
 
-INFO = {"program": "licensecheck", "version": "2022.2.0"}
+INFO = {"program": "licensecheck", "version": "2023.1.3", "license": "mit"}
 
 
 def stripAnsi(string: str) -> str:
@@ -48,30 +48,39 @@ def stripAnsi(string: str) -> str:
 	return re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])").sub("", string)
 
 
-def ansi(packages: list[PackageInfo]) -> str:
+def ansi(myLice: License, packages: list[PackageInfo]) -> str:
 	"""Format to ansi
 
 	Args:
+		myLice (License): project license
 		packages (list[PackageInfo]): list of PackageCompats to format.
 
 	Returns:
 		str: string to send to specified output in ansi format
 	"""
-	if len(packages) == 0:
-		return "No packages"
-
 	string = StringIO()
 
 	console = Console(file=string, color_system="truecolor")
 
+	table = Table(title="\nInfo")
+	table.add_column("Item", style="cyan")
+	table.add_column("Value", style="magenta")
+	_ = [table.add_row(k, v) for k, v in INFO.items()]
+	table.add_row("project_license", printLicense(myLice))
+
+	console.print(table)
+
+	if len(packages) == 0:
+		return f"{string.getvalue()}\nNo packages"
+
 	errors = [x for x in packages if x.errorCode > 0]
 	if len(errors) > 0:
-		table = Table(title="\nlist of errors")
+		table = Table(title="\nList Of Errors")
 		table.add_column("Package", style="magenta")
 		_ = [table.add_row(x.name) for x in errors]
 		console.print(table)
 
-	table = Table(title="\nlist of packages")
+	table = Table(title="\nList Of Packages")
 	table.add_column("Compatible", style="cyan")
 	table.add_column("Package", style="magenta")
 	table.add_column("License(s)", style="magenta")
@@ -84,43 +93,48 @@ def ansi(packages: list[PackageInfo]) -> str:
 	return string.getvalue()
 
 
-def plainText(packages: list[PackageInfo]) -> str:
-	"""Format to plain text
+def plainText(myLice: License, packages: list[PackageInfo]) -> str:
+	"""Format to ansi
 
 	Args:
+		myLice (License): project license
 		packages (list[PackageInfo]): list of PackageCompats to format.
 
 	Returns:
 		str: string to send to specified output in plain text format
 	"""
-	return stripAnsi(ansi(packages))
+	return stripAnsi(ansi(myLice, packages))
 
 
-def markdown(packages: list[PackageInfo]) -> str:
+def markdown(myLice: License, packages: list[PackageInfo]) -> str:
 	"""Format to markdown
 
 	Args:
+		myLice (License): project license
 		packages (list[PackageInfo]): list of PackageCompats to format.
 
 	Returns:
 		str: string to send to specified output in markdown format
 	"""
+	info = "\n".join(f"- **{k}**: {v}" for k, v in INFO.items())
+	strBuf = [f"## Info\n\n{info}\n\n## Project License\n\n{printLicense(myLice)}\n"]
+
 	if len(packages) == 0:
-		return "No packages"
+		return f"{strBuf[0]}\nNo packages"
 
-	strBuf = ["\n# Packages\nFind a list of packages below\n"]
+	strBuf.append("## Packages\n\nFind a list of packages below\n")
 	packages = sorted(packages, key=lambda i: i.name)
 
 	# Summary Table
 	strBuf.append("|Compatible|Package|\n|:--|:--|")
 	for pkg in packages:
-		strBuf.append(f"|{pkg.licenseCompat}|{pkg.name}|")
+		strBuf.append(f"|{'✔' if pkg.licenseCompat else '✖'}|{pkg.name}|")
 
 	# Details
 	for pkg in packages:
 		strBuf.extend(
 			[
-				f"\n## {pkg.namever}",
+				f"\n### {pkg.namever}",
 				f"\n- HomePage: {pkg.homePage}",
 				f"- Author: {pkg.author}",
 				f"- License: {pkg.license}",
@@ -131,27 +145,37 @@ def markdown(packages: list[PackageInfo]) -> str:
 	return "\n".join(strBuf) + "\n"
 
 
-def raw(packages: list[PackageInfo]) -> str:
-	"""Format to raw json
+def raw(myLice: License, packages: list[PackageInfo]) -> str:
+	"""Format to json
 
 	Args:
+		myLice (License): project license
 		packages (list[PackageInfo]): list of PackageCompats to format.
 
 	Returns:
 		str: string to send to specified output in raw json format
 	"""
-	return json.dumps({"info": INFO, "packages": [x.__dict__ for x in packages]}, indent="\t")
+	return json.dumps(
+		{
+			"info": INFO,
+			"project_license": printLicense(myLice),
+			"packages": [x.__dict__ for x in packages],
+		},
+		indent="\t",
+	)
 
 
-def rawCsv(packages: list[PackageInfo]) -> str:
-	"""Format to raw csv
+def rawCsv(myLice: License, packages: list[PackageInfo]) -> str:
+	"""Format to csv
 
 	Args:
+		myLice (License): project license
 		packages (list[PackageInfo]): list of PackageCompats to format.
 
 	Returns:
 		str: string to send to specified output in raw csv format
 	"""
+	_ = myLice
 	string = StringIO()
 	writer = csv.DictWriter(string, fieldnames=list(packages[0].__dict__), lineterminator="\n")
 	writer.writeheader()