rel 2024

Author: FredHappyface

CHANGELOG.md

@@ -3,7 +3,7 @@
 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 - 2022/04/09
+## 2024 - 2024/03/17
 
 - Removed ujson optional dependency per https://pythonspeed.com/articles/faster-json-library/:
   tldr it probably won't be significantly faster and may be error prone

documentation/reference/licensematrix/license_matrix.md

@@ -24,7 +24,7 @@ Make a list of Licenses from a json file.
 
 ```python
 class LicenseMatrix:
-    def __init__(self): ...
+    def __init__(self) -> None: ...
 ```
 
 ### LicenseMatrix().buildLicenses
@@ -87,6 +87,10 @@ def buildLicenses(
 ) -> list[License]: ...
 ```
 
+#### See also
+
+- [License](./license_type.md#license)
+
 ### LicenseMatrix().closestSPDX
 
 [Show source in license_matrix.py:150](../../../licensematrix/license_matrix.py#L150)
@@ -109,6 +113,10 @@ Guarantee a license from a spdx id (may be inaccurate).
 def closestSPDX(self, spdx: str) -> License: ...
 ```
 
+#### See also
+
+- [License](./license_type.md#license)
+
 ### LicenseMatrix().closestTitle
 
 [Show source in license_matrix.py:167](../../../licensematrix/license_matrix.py#L167)
@@ -131,6 +139,10 @@ Guarantee a license from a name (may be inaccurate).
 def closestTitle(self, name: str) -> License: ...
 ```
 
+#### See also
+
+- [License](./license_type.md#license)
+
 ### LicenseMatrix().licenseFromAltName
 
 [Show source in license_matrix.py:109](../../../licensematrix/license_matrix.py#L109)
@@ -217,4 +229,8 @@ Get a list of candidate licenses from a search string.
 
 ```python
 def searchLicenses(self, search: str) -> list[License]: ...
-```
+```
+
+#### See also
+
+- [License](./license_type.md#license)

documentation/reference/licensematrix/license_type.md

@@ -48,7 +48,7 @@ class License:
         typeIn: str = "",
         spdx: str = "",
         fromDict: dict[str, Any] | None = None,
-    ): ...
+    ) -> None: ...
 ```
 
 ### License().__repr__
@@ -79,7 +79,7 @@ def __str__(self) -> str: ...
 
 [Show source in license_type.py:89](../../../licensematrix/license_type.py#L89)
 
-Is the License Copyleft?
+Is the License Copyleft?.
 
 #### Signature
 
@@ -91,7 +91,7 @@ def isCopyleft(self): ...
 
 [Show source in license_type.py:81](../../../licensematrix/license_type.py#L81)
 
-Is the License Permissive?
+Is the License Permissive?.
 
 #### Signature
 
@@ -103,7 +103,7 @@ def isPermissive(self): ...
 
 [Show source in license_type.py:97](../../../licensematrix/license_type.py#L97)
 
-Is the License Public Domain?
+Is the License Public Domain?.
 
 #### Signature
 
@@ -115,7 +115,7 @@ def isPublicDomain(self): ...
 
 [Show source in license_type.py:93](../../../licensematrix/license_type.py#L93)
 
-Is the License Viral?
+Is the License Viral?.
 
 #### Signature
 
@@ -127,7 +127,7 @@ def isViral(self): ...
 
 [Show source in license_type.py:85](../../../licensematrix/license_type.py#L85)
 
-Is the License Weak Copyleft?
+Is the License Weak Copyleft?.
 
 #### Signature
 
@@ -303,7 +303,7 @@ def termsCompatible(self, dest: License) -> bool: ...
 
 [Show source in license_type.py:310](../../../licensematrix/license_type.py#L310)
 
-Are two licenses equal?
+Are two licenses equal?.
 
 #### Arguments
 

licensematrix/__init__.py

@@ -2,6 +2,6 @@
 
 from __future__ import annotations
 
-from .license_matrix import LicenseMatrix
+from licensematrix.license_matrix import LicenseMatrix
 
 licenseMatrix = LicenseMatrix()

licensematrix/license_matrix.py

@@ -7,7 +7,7 @@
 from operator import itemgetter
 from pathlib import Path
 
-from .license_type import License
+from licensematrix.license_type import License
 
 THISDIR = Path(__file__).resolve().parent
 
@@ -17,7 +17,7 @@ class LicenseMatrix:
 
 	__slots__ = ["licenses"]
 
-	def __init__(self):
+	def __init__(self) -> None:
 		"""Make a list of Licenses from a json file."""
 		self.licenses = self.buildLicenses()
 

licensematrix/license_type.py

@@ -27,7 +27,7 @@ def __init__(
 		typeIn: str = "",
 		spdx: str = "",
 		fromDict: dict[str, Any] | None = None,
-	):
+	) -> None:
 		"""Construct License. Create from a dict of 'by hand'.
 
 		Args:
@@ -79,23 +79,23 @@ def __str__(self) -> str:
 		return f"<{self.name} type:{self.type} spdx:{self.spdx}>"
 
 	def isPermissive(self):
-		"""Is the License Permissive?"""
+		"""Is the License Permissive?."""
 		return self.type == "Permissive"
 
 	def isWeakCopyleft(self):
-		"""Is the License Weak Copyleft?"""
+		"""Is the License Weak Copyleft?."""
 		return self.type == "Weak Copyleft"
 
 	def isCopyleft(self):
-		"""Is the License Copyleft?"""
+		"""Is the License Copyleft?."""
 		return self.type == "Copyleft"
 
 	def isViral(self):
-		"""Is the License Viral?"""
+		"""Is the License Viral?."""
 		return self.type == "Viral"
 
 	def isPublicDomain(self):
-		"""Is the License Public Domain?"""
+		"""Is the License Public Domain?."""
 		return self.type == "Public Domain"
 
 	def mergeBoth(self, rhs: License):
@@ -308,7 +308,7 @@ def mergeSPDX(spdxA: str, spdxB: str) -> str:
 
 
 def equal(licenseA: License, licenseB: License) -> bool:
-	"""Are two licenses equal?
+	"""Are two licenses equal?.
 
 	Args:
 	----

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "licensematrix"
-version = "2022"
+version = "2024"
 license = "mit"
 description = "List of popular open source licenses with naive functions to determine compatibility and search for a license from a string"
 authors = ["FredHappyface"]
@@ -29,6 +29,11 @@ python = "^3.8"
 [tool.poetry.group.dev.dependencies]
 requests = "^2.31.0"
 requests-cache = "^1.2.0"
+pytest = "^8.1.1"
+handsdown = "^2.1.0"
+coverage = "^7.4.4"
+ruff = "^0.2.2"
+pyright = "^1.1.354"
 
 [build-system]
 requires = ["poetry-core"]