2021.5

Author: FredHappyface

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+  - repo: https://github.com/FHPythonUtils/Blackt
+    rev: '2021'
+    hooks:
+      - id: blackt
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.9.3
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pycqa/pylint
+    rev: v2.11.1
+    hooks:
+      - id: pylint
+        args: [--disable=import-error,--jobs=0, --fail-under=9.8]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.29.0
+    hooks:
+      - id: pyupgrade
+        args: [--py37-plus]

CHANGELOG.md

@@ -2,68 +2,85 @@
 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).
 
+## 2021.5 - 2021/10/18
+
+- Compatible with pip 21.3
+- Code quality improvements
+
 ## 2021.5 - 2021/09/14
+
 - Add `-u poetry:dev` to command-line to include dev packages (excluded by default) per https://github.com/FHPythonUtils/LicenseCheck/issues/16
 - Add support for proprietary license per https://github.com/FHPythonUtils/LicenseCheck/issues/15
 - Raise RuntimeError if missing license and classifier https://github.com/FHPythonUtils/LicenseCheck/issues/14
 - Quality improvements to license_matrix.py
 - Add additional examples to readme
 - Support pre-commit-hooks https://github.com/FHPythonUtils/LicenseCheck/issues/8
 
-
 ## 2021.4.1 - 2021/09/07
+
 - Command-line options take precedent over config options as expected
 
 ## 2021.4 - 2021/09/07
+
 - Add config file functionality per https://github.com/FHPythonUtils/LicenseCheck/issues/11
-  - Parsed in the following order: `pyproject.toml`, `setup.cfg`, `licensecheck.toml`, `licensecheck.json`, `licensecheck.ini`, `~/licensecheck.toml`, `~/licensecheck.json`, `~/licensecheck.ini`
-  - Note that the config takes precedent over command-line options
+	- Parsed in the following order: `pyproject.toml`, `setup.cfg`, `licensecheck.toml`, `licensecheck.json`, `licensecheck.ini`, `~/licensecheck.toml`, `~/licensecheck.json`, `~/licensecheck.ini`
+	- Note that the config takes precedent over command-line options
 - Add optional path to requirements.txt as outlined in https://github.com/FHPythonUtils/LicenseCheck/issues/9#issuecomment-898878228
-  - Eg. `licensecheck --using requirements:c:/path/to/reqs.txt;path/to/other/reqs.txt`
+	- Eg. `licensecheck --using requirements:c:/path/to/reqs.txt;path/to/other/reqs.txt`
 
 ## 2021.3 - 2021/08/13
+
 - Add `--ignore-packages`, `--fail-packages`,`--ignore-licenses`, `--fail-licenses`, per https://github.com/FHPythonUtils/LicenseCheck/issues/7
 - Fix spelling
 - Added a couple examples to the readme
 - Added pylintrc to pyproject.toml
 
-
 ## 2021.2 - 2021/08/13
+
 - Added ability to use requirements.txt per https://github.com/FHPythonUtils/LicenseCheck/issues/6
 - Code clean-up + refactoring
 - Fix spelling
 - packagecompat.py → types.py as this module holds types + typing info
 
 ## 2021.1.2 - 2021/06/07
+
 - reformat
 - improve docstrings
 
 ## 2021.1.1 - 2021/03/01
+
 - Add PSFL to matrix.
 
 ## 2021.1 - 2021/03/01
+
 - Tidied up
 - Added `--zero/-0` flag to return non-zero exit code when an incompatible
-  license is found
+	license is found
 
 ## 2021 - 2021/01/24
+
 - Updated requirements
 - Fallback to requirements.txt when poetry throws an error and direct the user
-  to troubleshoot
+	to troubleshoot
 
 ## 2020.0.4 - 2020/10/14
+
 - Improved support for GPL fans out there by detecting variants in a more
-  granular manner. Fewer false -ves for said GPL variants. E.g. a dependency with
-  GPL2 only will be flagged for a project using GPL3
+	granular manner. Fewer false -ves for said GPL variants. E.g. a dependency with
+	GPL2 only will be flagged for a project using GPL3
 
 ## 2020.0.3 - 2020/10/12
+
 - set stdout to utf-8
 
 ## 2020.0.2 - 2020/10/12
+
 - fancy tables in simple and ansi formats
 
 ## 2020.0.1 - 2020/10/11
+
 - dependencies bugfix
 
 ## 2020 - 2020/10/09
+
 - First release

DOCS/licensecheck/formatter.md

@@ -33,13 +33,10 @@ Formats
 
 ## ansi
 
-[[find in source code]](../../licensecheck/formatter.py#L142)
+[[find in source code]](../../licensecheck/formatter.py#L141)
 
 ```python
-def ansi(
-    packages: list[PackageCompat],
-    heading: typing.Optional[str] = None,
-) -> str:
+def ansi(packages: list[PackageCompat], heading: str | None = None) -> str:
 ```
 
 Format to ansi.
@@ -55,13 +52,10 @@ Format to ansi.
 
 ## csv
 
-[[find in source code]](../../licensecheck/formatter.py#L100)
+[[find in source code]](../../licensecheck/formatter.py#L99)
 
 ```python
-def csv(
-    packages: list[PackageCompat],
-    heading: typing.Optional[str] = None,
-) -> str:
+def csv(packages: list[PackageCompat], heading: str | None = None) -> str:
 ```
 
 Format to CSV.
@@ -77,13 +71,10 @@ Format to CSV.
 
 ## json
 
-[[find in source code]](../../licensecheck/formatter.py#L80)
+[[find in source code]](../../licensecheck/formatter.py#L79)
 
 ```python
-def json(
-    packages: list[PackageCompat],
-    heading: typing.Optional[str] = None,
-) -> str:
+def json(packages: list[PackageCompat], heading: str | None = None) -> str:
 ```
 
 Format to Json.
@@ -99,12 +90,12 @@ Format to Json.
 
 ## markdown
 
-[[find in source code]](../../licensecheck/formatter.py#L41)
+[[find in source code]](../../licensecheck/formatter.py#L40)
 
 ```python
 def markdown(
     packages: list[PackageCompat],
-    heading: typing.Optional[str] = None,
+    heading: str | None = None,
 ) -> str:
 ```
 
@@ -121,7 +112,7 @@ Format to Markdown.
 
 ## simple
 
-[[find in source code]](../../licensecheck/formatter.py#L195)
+[[find in source code]](../../licensecheck/formatter.py#L194)
 
 ```python
 def simple(packages: list[PackageCompat]) -> str:

DOCS/licensecheck/index.md

@@ -2,7 +2,8 @@
 
 > Auto-generated documentation for [licensecheck](../../licensecheck/__init__.py) module.
 
-Output the licenses used by dependencies and check if these are compatible with the project license.
+Output the licenses used by dependencies and check if these are compatible with the project
+license.
 
 - [Licensecheck](../README.md#licensecheck-index) / [Modules](../README.md#licensecheck-modules) / licensecheck
     - [cli](#cli)
@@ -16,7 +17,7 @@ Output the licenses used by dependencies and check if these are compatible with
 
 ## cli
 
-[[find in source code]](../../licensecheck/__init__.py#L17)
+[[find in source code]](../../licensecheck/__init__.py#L18)
 
 ```python
 def cli() -> None:

DOCS/licensecheck/packageinfo.md

@@ -5,54 +5,34 @@
 Get information for installed and online packages.
 
 - [Licensecheck](../README.md#licensecheck-index) / [Modules](../README.md#licensecheck-modules) / [licensecheck](index.md#licensecheck) / packageinfo
-    - [calcContainer](#calccontainer)
     - [getModuleSize](#getmodulesize)
     - [getMyPackageLicense](#getmypackagelicense)
     - [getPackages](#getpackages)
     - [getPackagesFromLocal](#getpackagesfromlocal)
-    - [getPackagesFromOnline](#getpackagesfromonline)
-    - [licenseFromClassifierMessage](#licensefromclassifiermessage)
     - [licenseFromClassifierlist](#licensefromclassifierlist)
-
-## calcContainer
-
-[[find in source code]](../../licensecheck/packageinfo.py#L204)
-
-```python
-def calcContainer(path: str) -> int:
-```
-
-Get size of installed module from path.
-
-#### Arguments
-
-- `path` *str* - path to the module
-
-#### Returns
-
-- `int` - size in bytes
+    - [packageInfoFromPypi](#packageinfofrompypi)
 
 ## getModuleSize
 
-[[find in source code]](../../licensecheck/packageinfo.py#L221)
+[[find in source code]](../../licensecheck/packageinfo.py#L153)
 
 ```python
-def getModuleSize(pkg: Distribution) -> int:
+def getModuleSize(pkg: BaseDistribution) -> int:
 ```
 
 Get the size of a given module as an int.
 
 #### Arguments
 
-- `pkg` *Distribution* - package to get the size of
+- `pkg` *BaseDistribution* - package to get the size of
 
 #### Returns
 
 - `int` - size in bytes
 
 ## getMyPackageLicense
 
-[[find in source code]](../../licensecheck/packageinfo.py#L168)
+[[find in source code]](../../licensecheck/packageinfo.py#L120)
 
 ```python
 def getMyPackageLicense() -> str:
@@ -70,7 +50,7 @@ Get the pyproject data.
 
 ## getPackages
 
-[[find in source code]](../../licensecheck/packageinfo.py#L152)
+[[find in source code]](../../licensecheck/packageinfo.py#L104)
 
 ```python
 def getPackages(reqs: list[str]) -> list[PackageInfo]:
@@ -88,34 +68,13 @@ Get dependency info.
 
 ## getPackagesFromLocal
 
-[[find in source code]](../../licensecheck/packageinfo.py#L23)
+[[find in source code]](../../licensecheck/packageinfo.py#L18)
 
 ```python
 def getPackagesFromLocal(requirements: list[str]) -> list[PackageInfo]:
 ```
 
-Get a list of package info from local files including version, author...
-
-and	the license.
-
-#### Arguments
-
-- `requirements` *list[str]* - [description]
-
-#### Returns
-
-- `list[PackageInfo]` - [description]
-
-## getPackagesFromOnline
-
-[[find in source code]](../../licensecheck/packageinfo.py#L97)
-
-```python
-def getPackagesFromOnline(requirements: list[str]) -> list[PackageInfo]:
-```
-
-Get a list of package info from pypi.org including version, author...
-
+Get a list of package info from local files including version, author
 and	the license.
 
 #### Arguments
@@ -126,38 +85,39 @@ and	the license.
 
 - `list[PackageInfo]` - [description]
 
-## licenseFromClassifierMessage
+## licenseFromClassifierlist
 
-[[find in source code]](../../licensecheck/packageinfo.py#L75)
+[[find in source code]](../../licensecheck/packageinfo.py#L86)
 
 ```python
-def licenseFromClassifierMessage(message: Message) -> str:
+def licenseFromClassifierlist(classifiers: list[str]) -> str:
 ```
 
-Get license string from a Message of project classifiers.
+Get license string from a list of project classifiers.
 
 #### Arguments
 
-- `message` *Message* - Message of classifiers
+- `classifiers` *list[str]* - list of classifiers
 
 #### Returns
 
 - `str` - the license name
 
-## licenseFromClassifierlist
+## packageInfoFromPypi
 
-[[find in source code]](../../licensecheck/packageinfo.py#L130)
+[[find in source code]](../../licensecheck/packageinfo.py#L56)
 
 ```python
-def licenseFromClassifierlist(classifiers: list[str]) -> str:
+def packageInfoFromPypi(requirements: list[str]) -> list[PackageInfo]:
 ```
 
-Get license string from a list of project classifiers.
+Get a list of package info from pypi.org including version, author
+and	the license.
 
 #### Arguments
 
-- `classifiers` *list[str]* - list of classifiers
+- `requirements` *list[str]* - [description]
 
 #### Returns
 
-- `str` - the license name
+- `list[PackageInfo]` - [description]