release: 2022.3

Author: FredHappyface

CHANGELOG.md

@@ -3,6 +3,12 @@
 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).
 
+## 2022.3.0 - 2022/12/30
+
+- Combined `PackageCompat` and `PackageInfo` to a `@dataclass` of `PackageInfo`
+- `get_deps.py` and `packageinfo.py` use sets in-place of lists. NOTE: `list(depsWithLicenses)` is passed to `formatter.py` (which expects lists of `PackageInfo`)
+
+
 ## 2022.2.0 - 2022/10/22
 
 - Add support for `setup.cfg` https://github.com/FHPythonUtils/LicenseCheck/issues/21

README.md

@@ -16,13 +16,13 @@ Formatter
 
 ## ansi
 
-[Show source in formatter.py:50](../../../licensecheck/formatter.py#L50)
+[Show source in formatter.py:51](../../../licensecheck/formatter.py#L51)
 
 Format to ansi
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - list of PackageCompats to format.
+- `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
 
@@ -31,25 +31,25 @@ Format to ansi
 #### Signature
 
 ```python
-def ansi(packages: list[PackageCompat]) -> str:
+def ansi(packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
-- [PackageCompat](./types.md#packagecompat)
+- [PackageInfo](./types.md#packageinfo)
 
 
 
 ## markdown
 
-[Show source in formatter.py:91](../../../licensecheck/formatter.py#L91)
+[Show source in formatter.py:99](../../../licensecheck/formatter.py#L99)
 
 Format to markdown
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - list of PackageCompats to format.
+- `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
 
@@ -58,25 +58,25 @@ Format to markdown
 #### Signature
 
 ```python
-def markdown(packages: list[PackageCompat]) -> str:
+def markdown(packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
-- [PackageCompat](./types.md#packagecompat)
+- [PackageInfo](./types.md#packageinfo)
 
 
 
 ## plainText
 
-[Show source in formatter.py:79](../../../licensecheck/formatter.py#L79)
+[Show source in formatter.py:87](../../../licensecheck/formatter.py#L87)
 
 Format to plain text
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - list of PackageCompats to format.
+- `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
 
@@ -85,25 +85,25 @@ Format to plain text
 #### Signature
 
 ```python
-def plainText(packages: list[PackageCompat]) -> str:
+def plainText(packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
-- [PackageCompat](./types.md#packagecompat)
+- [PackageInfo](./types.md#packageinfo)
 
 
 
 ## raw
 
-[Show source in formatter.py:127](../../../licensecheck/formatter.py#L127)
+[Show source in formatter.py:134](../../../licensecheck/formatter.py#L134)
 
 Format to raw json
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - list of PackageCompats to format.
+- `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
 
@@ -112,25 +112,25 @@ Format to raw json
 #### Signature
 
 ```python
-def raw(packages: list[PackageCompat]) -> str:
+def raw(packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
-- [PackageCompat](./types.md#packagecompat)
+- [PackageInfo](./types.md#packageinfo)
 
 
 
 ## rawCsv
 
-[Show source in formatter.py:139](../../../licensecheck/formatter.py#L139)
+[Show source in formatter.py:146](../../../licensecheck/formatter.py#L146)
 
 Format to raw csv
 
 #### Arguments
 
-- `packages` *list[PackageCompat]* - list of PackageCompats to format.
+- `packages` *list[PackageInfo]* - list of PackageCompats to format.
 
 #### Returns
 
@@ -139,19 +139,19 @@ Format to raw csv
 #### Signature
 
 ```python
-def rawCsv(packages: list[PackageCompat]) -> str:
+def rawCsv(packages: list[PackageInfo]) -> str:
     ...
 ```
 
 #### See also
 
-- [PackageCompat](./types.md#packagecompat)
+- [PackageInfo](./types.md#packageinfo)
 
 
 
 ## stripAnsi
 
-[Show source in formatter.py:38](../../../licensecheck/formatter.py#L38)
+[Show source in formatter.py:39](../../../licensecheck/formatter.py#L39)
 
 Strip ansi codes from a given string
 

documentation/reference/licensecheck/formatter.md

@@ -14,7 +14,7 @@ Get Deps
 
 [Show source in get_deps.py:90](../../../licensecheck/get_deps.py#L90)
 
-Get a list of dependencies with licenses and determin license compatibility.
+Get a set of dependencies with licenses and determin license compatibility.
 
 #### Arguments
 
@@ -26,7 +26,7 @@ Get a list of dependencies with licenses and determin license compatibility.
 
 #### Returns
 
-- `list[PackageCompat]` - list of packagecompat types: dependency info + licence compat
+- `set[PackageInfo]` - set of updated dependencies with licenseCompat set
 
 #### Signature
 
@@ -37,13 +37,13 @@ def getDepsWithLicenses(
     failPackages: list[str],
     ignoreLicenses: list[str],
     failLicenses: list[str],
-) -> list[PackageCompat]:
+) -> set[PackageInfo]:
     ...
 ```
 
 #### See also
 
-- [PackageCompat](./types.md#packagecompat)
+- [PackageInfo](./types.md#packageinfo)
 
 
 
@@ -66,12 +66,12 @@ Get requirements for the end user project/ lib.
 
 #### Returns
 
-- `list[str]` - list of requirement packages
+- `set[str]` - set of requirement packages
 
 #### Signature
 
 ```python
-def getReqs(using: str) -> list[str]:
+def getReqs(using: str) -> set[str]:
     ...
 ```
 

documentation/reference/licensecheck/get_deps.md

@@ -52,8 +52,8 @@ Identify if the end user license is compatible with the dependency license(s).
 def depCompatWMyLice(
     myLicense: L,
     depLice: list[L],
-    ignoreLicenses: list[L] = None,
-    failLicenses: list[L] = None,
+    ignoreLicenses: list[L] | None = None,
+    failLicenses: list[L] | None = None,
 ) -> bool:
     ...
 ```