2021.5

Author: FredHappyface

.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+- id: licensecheck
+  name: licensecheck
+  description: "Output the licenses used by dependencies and check if these are compatible with the project license"
+  entry: licensecheck --zero
+  language: python
+  minimum_pre_commit_version: 2.9.2
+  pass_filenames: false

CHANGELOG.md

@@ -2,12 +2,13 @@
 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/09/xx
+## 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

DOCS/licensecheck/license_matrix.md

@@ -6,6 +6,7 @@ Define a foss compatability license_matrix.
 
 - [Licensecheck](../README.md#licensecheck-index) / [Modules](../README.md#licensecheck-modules) / [licensecheck](index.md#licensecheck) / license_matrix
     - [depCompatWMyLice](#depcompatwmylice)
+    - [licenseLookup](#licenselookup)
     - [licenseType](#licensetype)
 
 Standard disclaimer:: I am not a lawyer and there is no guarantee that the
@@ -43,36 +44,36 @@ EU -> gpl -> agpl (3 only)
 
 #### Attributes
 
-- `PERMISSIVE` - Permissive licenses compatible with GPL: `[License.MIT, License.BOOST, License.BSD, Licen...`
-- `PERMISSIVE_OTHER` - Permissive licenses NOT compatible with GPL: `[License.APACHE, License.ECLIPSE, License.ACADEMIC_FREE]`
-- `LGPL` - LGPL licenses: `[License.LGPL_2, License.LGPL_3, License.LGPL_2...`
-- `GPL` - GPL licenses (including AGPL): `[License.GPL_2, License.GPL_3, License.GPL_2_PL...`
-- `OTHER_COPYLEFT` - Other Copyleft licenses: `[License.MPL, License.EU]`
+- `PERMISSIVE` - Permissive licenses compatible with GPL: `[L.MIT, L.BOOST, L.BSD, L.ISC, L.NCSA, L.PSFL]`
+- `PERMISSIVE_OTHER` - Permissive licenses NOT compatible with GPL: `[L.APACHE, L.ECLIPSE, L.ACADEMIC_FREE]`
+- `LGPL` - LGPL licenses: `[L.LGPL_2, L.LGPL_3, L.LGPL_2_PLUS, L.LGPL_3_PLUS, L.LGPL_X]`
+- `GPL` - GPL licenses (including AGPL): `[L.GPL_2, L.GPL_3, L.GPL_2_PLUS, L.GPL_3_PLUS, L.GPL_X, L.AGPL_3_PLUS]`
+- `OTHER_COPYLEFT` - Other Copyleft licenses: `[L.MPL, L.EU]`
 - `UNLICENSE_INCOMPATIBLE` - Basic compat matrix: `PERMISSIVE + PERMISSIVE_OTHER + GPL + LGPL + OT...`
 - `GPL_2_INCOMPATIBLE` - GPL compat matrix
-  https://www.gnu.org/licenses/gpl-faq.html#AllCompatibility: `[License.GPL_3, License.GPL_3_PLUS, License.LGPL_3, License.LGPL_3_PLUS]`
+  https://www.gnu.org/licenses/gpl-faq.html#AllCompatibility: `[L.GPL_3, L.GPL_3_PLUS, L.LGPL_3, L.LGPL_3_PLUS]`
 
 ## depCompatWMyLice
 
-[[find in source code]](../../licensecheck/license_matrix.py#L168)
+[[find in source code]](../../licensecheck/license_matrix.py#L153)
 
 ```python
 def depCompatWMyLice(
-    myLicense: License,
-    depLice: list[License],
-    ignoreLicenses: list[License] = None,
-    failLicenses: list[License] = None,
+    myLicense: L,
+    depLice: list[L],
+    ignoreLicenses: list[L] = None,
+    failLicenses: list[L] = None,
 ) -> bool:
 ```
 
 Identify if the end user license is compatible with the dependency license(s).
 
 #### Arguments
 
-- `myLicense` *License* - end user license to check
-- `depLice` *list[License]* - dependency license
-- `ignoreLicenses` *list[License], optional* - list of licenses to ignore. Defaults to None.
-- `failLicenses` *list[License], optional* - list of licenses to fail on. Defaults to None.
+- `myLicense` *L* - end user license to check
+- `depLice` *list[L]* - dependency license
+- `ignoreLicenses` *list[L], optional* - list of licenses to ignore. Defaults to None.
+- `failLicenses` *list[L], optional* - list of licenses to fail on. Defaults to None.
 
 #### Returns
 
@@ -82,12 +83,34 @@ Identify if the end user license is compatible with the dependency license(s).
 
 - [License](types.md#license)
 
-## licenseType
+## licenseLookup
 
 [[find in source code]](../../licensecheck/license_matrix.py#L43)
 
 ```python
-def licenseType(lice: str) -> list[License]:
+def licenseLookup(licenseStr: str) -> L:
+```
+
+Identify a license from an uppercase string representation of a license.
+
+#### Arguments
+
+- `licenseStr` *str* - uppercase string representation of a license
+
+#### Returns
+
+- `L` - License represented by licenseStr
+
+#### See also
+
+- [License](types.md#license)
+
+## licenseType
+
+[[find in source code]](../../licensecheck/license_matrix.py#L86)
+
+```python
+def licenseType(lice: str) -> list[L]:
 ```
 
 Return a list of license types from a license string.
@@ -98,4 +121,4 @@ Return a list of license types from a license string.
 
 #### Returns
 
-- `list[License]` - the license
+- `list[L]` - the license

DOCS/licensecheck/packageinfo.md

@@ -5,7 +5,6 @@
 Get information for installed and online packages.
 
 - [Licensecheck](../README.md#licensecheck-index) / [Modules](../README.md#licensecheck-modules) / [licensecheck](index.md#licensecheck) / packageinfo
-    - [PackageInfo](#packageinfo)
     - [calcContainer](#calccontainer)
     - [getModuleSize](#getmodulesize)
     - [getMyPackageLicense](#getmypackagelicense)
@@ -15,19 +14,9 @@ Get information for installed and online packages.
     - [licenseFromClassifierMessage](#licensefromclassifiermessage)
     - [licenseFromClassifierlist](#licensefromclassifierlist)
 
-## PackageInfo
-
-[[find in source code]](../../licensecheck/packageinfo.py#L21)
-
-```python
-class PackageInfo(typing.TypedDict):
-```
-
-PackageInfo type.
-
 ## calcContainer
 
-[[find in source code]](../../licensecheck/packageinfo.py#L207)
+[[find in source code]](../../licensecheck/packageinfo.py#L204)
 
 ```python
 def calcContainer(path: str) -> int:
@@ -45,7 +34,7 @@ Get size of installed module from path.
 
 ## getModuleSize
 
-[[find in source code]](../../licensecheck/packageinfo.py#L224)
+[[find in source code]](../../licensecheck/packageinfo.py#L221)
 
 ```python
 def getModuleSize(pkg: Distribution) -> int:
@@ -63,7 +52,7 @@ Get the size of a given module as an int.
 
 ## getMyPackageLicense
 
-[[find in source code]](../../licensecheck/packageinfo.py#L178)
+[[find in source code]](../../licensecheck/packageinfo.py#L168)
 
 ```python
 def getMyPackageLicense() -> str:
@@ -75,9 +64,13 @@ Get the pyproject data.
 
 - `str` - license name
 
+#### Raises
+
+- `RuntimeError` - Must specify a license using license spdx or classifier (tool.poetry or tool.flit)
+
 ## getPackages
 
-[[find in source code]](../../licensecheck/packageinfo.py#L162)
+[[find in source code]](../../licensecheck/packageinfo.py#L152)
 
 ```python
 def getPackages(reqs: list[str]) -> list[PackageInfo]:
@@ -95,7 +88,7 @@ Get dependency info.
 
 ## getPackagesFromLocal
 
-[[find in source code]](../../licensecheck/packageinfo.py#L33)
+[[find in source code]](../../licensecheck/packageinfo.py#L23)
 
 ```python
 def getPackagesFromLocal(requirements: list[str]) -> list[PackageInfo]:
@@ -115,7 +108,7 @@ and	the license.
 
 ## getPackagesFromOnline
 
-[[find in source code]](../../licensecheck/packageinfo.py#L107)
+[[find in source code]](../../licensecheck/packageinfo.py#L97)
 
 ```python
 def getPackagesFromOnline(requirements: list[str]) -> list[PackageInfo]:
@@ -135,7 +128,7 @@ and	the license.
 
 ## licenseFromClassifierMessage
 
-[[find in source code]](../../licensecheck/packageinfo.py#L85)
+[[find in source code]](../../licensecheck/packageinfo.py#L75)
 
 ```python
 def licenseFromClassifierMessage(message: Message) -> str:
@@ -153,7 +146,7 @@ Get license string from a Message of project classifiers.
 
 ## licenseFromClassifierlist
 
-[[find in source code]](../../licensecheck/packageinfo.py#L140)
+[[find in source code]](../../licensecheck/packageinfo.py#L130)
 
 ```python
 def licenseFromClassifierlist(classifiers: list[str]) -> str:

DOCS/licensecheck/types.md

@@ -7,10 +7,11 @@ PackageCompat type.
 - [Licensecheck](../README.md#licensecheck-index) / [Modules](../README.md#licensecheck-modules) / [licensecheck](index.md#licensecheck) / types
     - [License](#license)
     - [PackageCompat](#packagecompat)
+    - [PackageInfo](#packageinfo)
 
 ## License
 
-[[find in source code]](../../licensecheck/types.py#L20)
+[[find in source code]](../../licensecheck/types.py#L25)
 
 ```python
 class License(Enum):
@@ -27,14 +28,29 @@ License Enum to hold a set of potential licenses.
 - `GPL_X` - GPL: `40`
 - `AGPL_3_PLUS` - AGPL: `50`
 - `MPL` - Other copyleft: `60`
+- `PROPRIETARY` - PROPRIETARY: `190`
 - `NO_LICENSE` - No License: `200`
 
 ## PackageCompat
 
-[[find in source code]](../../licensecheck/types.py#L7)
+[[find in source code]](../../licensecheck/types.py#L19)
 
 ```python
-class PackageCompat(typing.TypedDict):
+class PackageCompat(PackageInfo):
 ```
 
 PackageCompat type.
+
+#### See also
+
+- [PackageInfo](#packageinfo)
+
+## PackageInfo
+
+[[find in source code]](../../licensecheck/types.py#L7)
+
+```python
+class PackageInfo(typing.TypedDict):
+```
+
+PackageInfo type.

licensecheck/__init__.py

@@ -31,7 +31,8 @@ def cli() -> None:
 	parser.add_argument(
 		"--using",
 		"-u",
-		help=f"Environment to use e.g. requirements.txt. one of: {', '.join(get_deps.USINGS)}. default=poetry",
+		help="Environment to use e.g. requirements.txt. one of: "
+		f"{', '.join(get_deps.USINGS)}. default=poetry",
 	)
 	parser.add_argument(
 		"--ignore-packages",
@@ -75,31 +76,38 @@ def cli() -> None:
 		["tool"],
 		["tool"],
 	)
-	sc = SimpleConf(configparser, "licensecheck", args)
+	simpleConf = SimpleConf(configparser, "licensecheck", args)
 
 	# File
-	filename = stdout if sc.get("file") is None else open(sc.get("file"), "w")
+	filename = (
+		stdout
+		if simpleConf.get("file") is None
+		else open(simpleConf.get("file"), "w", encoding="utf-8")
+	)
 
 	# Get list of licenses
 	dependenciesWLicenses = get_deps.getDepsWLicenses(
-		sc.get("using", "poetry"),
-		sc.get("ignore_packages", []),
-		sc.get("fail_packages", []),
-		sc.get("ignore_licenses", []),
-		sc.get("fail_licenses", []),
+		simpleConf.get("using", "poetry"),
+		simpleConf.get("ignore_packages", []),
+		simpleConf.get("fail_packages", []),
+		simpleConf.get("ignore_licenses", []),
+		simpleConf.get("fail_licenses", []),
 	)
 
 	# Are any licenses incompatible?
 	incompatible = any(not lice["license_compat"] for lice in dependenciesWLicenses)
 
 	# Format the results
-	if sc.get("format", "simple") in formatter.formatMap:
-		print(formatter.formatMap[sc.get("format", "simple")](dependenciesWLicenses), file=filename)
+	if simpleConf.get("format", "simple") in formatter.formatMap:
+		print(
+			formatter.formatMap[simpleConf.get("format", "simple")](dependenciesWLicenses),
+			file=filename,
+		)
 	else:
 		exitCode = 2
 
 	# Exit code of 1 if args.zero
-	if sc.get("zero", False) and incompatible:
+	if simpleConf.get("zero", False) and incompatible:
 		exitCode = 1
 
 	# Cleanup + exit

licensecheck/packageinfo.py

@@ -15,19 +15,9 @@
 from pip._internal.utils.misc import get_installed_distributions
 from pip._vendor.pkg_resources import Distribution
 
-UNKNOWN = "UNKNOWN"
-
+from licensecheck.types import PackageInfo
 
-class PackageInfo(typing.TypedDict):
-	"""PackageInfo type."""
-
-	name: str
-	version: str
-	namever: str
-	size: int
-	home_page: str
-	author: str
-	license: str
+UNKNOWN = "UNKNOWN"
 
 
 def getPackagesFromLocal(requirements: list[str]) -> list[PackageInfo]:

licensecheck/types.py

@@ -4,8 +4,8 @@
 from enum import Enum
 
 
-class PackageCompat(typing.TypedDict):
-	"""PackageCompat type."""
+class PackageInfo(typing.TypedDict):
+	"""PackageInfo type."""
 
 	name: str
 	version: str
@@ -14,6 +14,11 @@ class PackageCompat(typing.TypedDict):
 	home_page: str
 	author: str
 	license: str
+
+
+class PackageCompat(PackageInfo):
+	"""PackageCompat type."""
+
 	license_compat: bool
 
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "licensecheck"
-version = "2021.4.1"
+version = "2021.5"
 description = "Output the licenses used by dependencies and check if these are compatible with the project license"
 authors = ["FredHappyface"]
 classifiers = [