fixes

Author: FredHappyface

CHANGELOG.md

@@ -3,6 +3,16 @@
 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).
 
+## 2025.0.1 - 2025/03/16
+
+- update the cli interface to remove some confusing functionality
+- refactor the library / code qa improvements
+- Allow for alias of classifier in setup.cfg, thanks https://github.com/ericwb: #106
+- Add support for SPDX license expression metadata after PEP 639: #107
+- Add use regex/glob pattern to ignore multiple packages, thanks https://github.com/JulianKimmig: #108
+- Prioritise ['project'] table over ['tool.poetry'] in pyproject.toml: #104
+- Add option to show only failing packages: #98
+
 ## 2024.3 - 2024/08/26
 
 - Use uv to parse dependencies before falling back to the native resolver

README.md

@@ -10,7 +10,7 @@
 
 ## check
 
-[Show source in checker.py:43](../../../licensecheck/checker.py#L43)
+[Show source in checker.py:47](../../../licensecheck/checker.py#L47)
 
 #### Signature
 
@@ -39,13 +39,16 @@ def check(
 
 ## resolve_requirements
 
-[Show source in checker.py:17](../../../licensecheck/checker.py#L17)
+[Show source in checker.py:18](../../../licensecheck/checker.py#L18)
 
 #### Signature
 
 ```python
 def resolve_requirements(
-    requirements_paths: list[str], groups: list[str], skip_dependencies: list[ucstr]
+    requirements_paths: list[str],
+    groups: list[str],
+    skip_dependencies: list[ucstr],
+    index_url: str,
 ) -> set[ucstr]: ...
 ```
 

documentation/reference/licensecheck/checker.md

@@ -24,7 +24,7 @@ def cli() -> None: ...
 
 ## main
 
-[Show source in cli.py:112](../../../licensecheck/cli.py#L112)
+[Show source in cli.py:117](../../../licensecheck/cli.py#L117)
 
 Test entry point.
 
@@ -35,5 +35,5 @@ Note: FHConfParser (Parses in the following order: `pyproject.toml`,
 #### Signature
 
 ```python
-def main(args: dict | argparse.Namespace) -> int: ...
+def main(args: dict) -> int: ...
 ```

documentation/reference/licensecheck/cli.md

@@ -22,7 +22,7 @@
 
 ## LocalPackageInfo
 
-[Show source in packageinfo.py:75](../../../licensecheck/packageinfo.py#L75)
+[Show source in packageinfo.py:77](../../../licensecheck/packageinfo.py#L77)
 
 Handles retrieval of package info from local installation.
 
@@ -34,7 +34,7 @@ class LocalPackageInfo: ...
 
 ### LocalPackageInfo.get_info
 
-[Show source in packageinfo.py:78](../../../licensecheck/packageinfo.py#L78)
+[Show source in packageinfo.py:80](../../../licensecheck/packageinfo.py#L80)
 
 Retrieve package metadata from local installation.
 
@@ -61,7 +61,7 @@ def get_info(package: ucstr) -> PackageInfo: ...
 
 ### LocalPackageInfo.get_size
 
-[Show source in packageinfo.py:104](../../../licensecheck/packageinfo.py#L104)
+[Show source in packageinfo.py:106](../../../licensecheck/packageinfo.py#L106)
 
 Retrieve installed package size.
 
@@ -97,12 +97,12 @@ Manages retrieval of local and remote package information.
 
 ```python
 class PackageInfoManager:
-    def __init__(self, pypi_api: str = "https://pypi.org/pypi/") -> None: ...
+    def __init__(self, base_pypi_url: str = "https://pypi.org") -> None: ...
 ```
 
 ### PackageInfoManager().getPackages
 
-[Show source in packageinfo.py:34](../../../licensecheck/packageinfo.py#L34)
+[Show source in packageinfo.py:36](../../../licensecheck/packageinfo.py#L36)
 
 Retrieve package information from local installation or PyPI.
 
@@ -126,7 +126,7 @@ def getPackages(self, reqs: set[ucstr]) -> set[PackageInfo]: ...
 
 ### PackageInfoManager().get_package_info
 
-[Show source in packageinfo.py:48](../../../licensecheck/packageinfo.py#L48)
+[Show source in packageinfo.py:50](../../../licensecheck/packageinfo.py#L50)
 
 Retrieve package information, preferring local data.
 
@@ -154,7 +154,7 @@ def get_package_info(self, package: ucstr) -> PackageInfo: ...
 
 ## ProjectMetadata
 
-[Show source in packageinfo.py:192](../../../licensecheck/packageinfo.py#L192)
+[Show source in packageinfo.py:194](../../../licensecheck/packageinfo.py#L194)
 
 Handles extraction of project metadata from configuration files.
 
@@ -166,7 +166,7 @@ class ProjectMetadata: ...
 
 ### ProjectMetadata.get_license
 
-[Show source in packageinfo.py:220](../../../licensecheck/packageinfo.py#L220)
+[Show source in packageinfo.py:222](../../../licensecheck/packageinfo.py#L222)
 
 Extract license from project metadata.
 
@@ -188,7 +188,7 @@ def get_license() -> ucstr: ...
 
 ### ProjectMetadata.get_metadata
 
-[Show source in packageinfo.py:195](../../../licensecheck/packageinfo.py#L195)
+[Show source in packageinfo.py:197](../../../licensecheck/packageinfo.py#L197)
 
 Extract project metadata from setup.cfg or pyproject.toml.
 
@@ -208,7 +208,7 @@ def get_metadata() -> dict[str, Any]: ...
 
 ## RemotePackageInfo
 
-[Show source in packageinfo.py:115](../../../licensecheck/packageinfo.py#L115)
+[Show source in packageinfo.py:117](../../../licensecheck/packageinfo.py#L117)
 
 Handles retrieval of package info from PyPI.
 
@@ -220,7 +220,7 @@ class RemotePackageInfo: ...
 
 ### RemotePackageInfo.get_info
 
-[Show source in packageinfo.py:118](../../../licensecheck/packageinfo.py#L118)
+[Show source in packageinfo.py:120](../../../licensecheck/packageinfo.py#L120)
 
 Retrieve package metadata from PyPI.
 
@@ -248,7 +248,7 @@ def get_info(package: ucstr, pypi_api: str) -> PackageInfo: ...
 
 ### RemotePackageInfo.get_size
 
-[Show source in packageinfo.py:148](../../../licensecheck/packageinfo.py#L148)
+[Show source in packageinfo.py:150](../../../licensecheck/packageinfo.py#L150)
 
 Retrieve package size from PyPI metadata.
 
@@ -270,7 +270,7 @@ def get_size(data: dict[str, Any]) -> int: ...
 
 ## from_classifiers
 
-[Show source in packageinfo.py:173](../../../licensecheck/packageinfo.py#L173)
+[Show source in packageinfo.py:175](../../../licensecheck/packageinfo.py#L175)
 
 Extract license from classifiers.
 
@@ -295,7 +295,7 @@ def from_classifiers(classifiers: list[str] | None) -> ucstr: ...
 
 ## meta_get
 
-[Show source in packageinfo.py:160](../../../licensecheck/packageinfo.py#L160)
+[Show source in packageinfo.py:162](../../../licensecheck/packageinfo.py#L162)
 
 Retrieve metadata value safely.
 

documentation/reference/licensecheck/packageinfo.md

@@ -15,7 +15,10 @@
 
 ```python
 def get_reqs(
-    skipDependencies: list[ucstr], extras: list[str], requirementsPaths: list[str]
+    skipDependencies: list[ucstr],
+    extras: list[str],
+    requirementsPaths: list[str],
+    index_url: str = "https://pypi.org",
 ) -> set[ucstr]: ...
 ```
 

documentation/reference/licensecheck/resolvers/uv.md

@@ -6,6 +6,7 @@
 from pathlib import Path
 
 import tomli
+from loguru import logger
 
 from licensecheck import license_matrix
 from licensecheck.packageinfo import PackageInfoManager
@@ -18,15 +19,18 @@ def resolve_requirements(
 	requirements_paths: list[str],
 	groups: list[str],
 	skip_dependencies: list[ucstr],
+	index_url: str,
 ) -> set[ucstr]:
 	try:
 		return res_uv.get_reqs(
 			skipDependencies=skip_dependencies,
 			extras=groups,
 			requirementsPaths=requirements_paths,
+			index_url=index_url,
 		)
 
-	except RuntimeError:
+	except RuntimeError as e:
+		logger.warning(e)
 		pyproject = {}
 		if "pyproject.toml" in requirements_paths:
 			pyproject = tomli.loads(Path("pyproject.toml").read_text("utf-8"))
@@ -60,7 +64,12 @@ def check(
 	only_licenses = only_licenses or []
 	skip_dependencies = skip_dependencies or []
 
-	requirements = resolve_requirements(requirements_paths, groups, skip_dependencies)
+	requirements = resolve_requirements(
+		requirements_paths,
+		groups,
+		skip_dependencies,
+		index_url=package_info_manager.pypi_search,
+	)
 
 	ignoreLicensesType = license_matrix.licenseType(
 		ucstr(JOINS.join(ignore_licenses)), ignore_licenses

licensecheck/checker.py

@@ -34,7 +34,7 @@ def cli() -> None:  # pragma: no cover
 	parser.add_argument(
 		"--requirements-paths",
 		"-r",
-		help="Filenames to read from (omit for stdin)",
+		help="Filenames to read from (omit for stdin if piping, else pyproject.toml)",
 		nargs="+",
 	)
 	parser.add_argument(
@@ -91,7 +91,7 @@ def cli() -> None:  # pragma: no cover
 	parser.add_argument(
 		"--pypi-api",
 		help="Specify a custom pypi api endpoint, for example if using a custom pypi server",
-		default="https://pypi.org/pypi/",
+		default="https://pypi.org",
 	)
 	parser.add_argument(
 		"--zero",
@@ -100,16 +100,21 @@ def cli() -> None:  # pragma: no cover
 		action="store_true",
 	)
 	args = vars(parser.parse_args())
+
 	stdin_path = Path("__stdin__")
-	if stdin:
-		stdin_path.write_text("\n".join(stdin.readlines()), "utf-8")
+	if not args.get("requirements_paths"):
+		if stdin.isatty():
+			args["requirements_paths"] = ["pyproject.toml"]
+		else:
+			stdin_path.write_text("\n".join(stdin.readlines()), encoding="utf-8")
+
 	ec = main(args)
 	stdin_path.unlink(missing_ok=True)
 
 	sysexit(ec)
 
 
-def main(args: dict | argparse.Namespace) -> int:
+def main(args: dict) -> int:
 	"""Test entry point.
 
 	Note: FHConfParser (Parses in the following order: `pyproject.toml`,
@@ -142,7 +147,7 @@ def main(args: dict | argparse.Namespace) -> int:
 
 	# Get my license
 	this_license_text = (
-		args["license"] if args.get("license") else packageinfo.getMyPackageLicense()
+		args["license"] if args.get("license") else packageinfo.ProjectMetadata.get_license()
 	)
 	this_license = license_matrix.licenseType(this_license_text)[0]
 

licensecheck/cli.py

@@ -23,13 +23,15 @@
 class PackageInfoManager:
 	"""Manages retrieval of local and remote package information."""
 
-	def __init__(self, pypi_api: str = "https://pypi.org/pypi/") -> None:
+	def __init__(self, base_pypi_url: str = "https://pypi.org") -> None:
 		"""Manage retrieval of local and remote package information.
 
 		:param str pypi_api: url of pypi server. Typically the public instance, defaults
-		to "https://pypi.org/pypi/"
+		to "https://pypi.org"
 		"""
-		self.pypi_api = pypi_api
+		self.base_pypi_url = base_pypi_url
+		self.pypi_api = base_pypi_url + "/pypi/"
+		self.pypi_search = base_pypi_url + "/simple/"
 
 	def getPackages(self, reqs: set[ucstr]) -> set[PackageInfo]:
 		"""Retrieve package information from local installation or PyPI.

licensecheck/packageinfo.py

@@ -110,7 +110,8 @@ def resolveExtraReq(extraReq: str) -> ucstr | None:
 			msg = "Could not find specification of requirements (pyproject.toml)."
 			raise RuntimeError(msg) from error
 		for extra in extras:
-			reqLists.append(project["optional-dependencies"][extra])
+			extra_info = project.get("optional-dependencies", {}).get(extra)
+			reqLists.append(extra_info) if extra_info else ""
 		for reqList in reqLists:
 			for req in reqList:
 				reqs.add(resolveReq(req))

licensecheck/resolvers/native.py

@@ -16,6 +16,7 @@ def get_reqs(
 	skipDependencies: list[ucstr],
 	extras: list[str],
 	requirementsPaths: list[str],
+	index_url: str = "https://pypi.org",
 ) -> set[ucstr]:
 	for idx, requirement in enumerate(requirementsPaths):
 		if not Path(requirement).exists():
@@ -29,7 +30,9 @@ def get_reqs(
 			requirementsPaths[idx] = destination_file.as_posix()
 
 	extras_cmd = [f"--extra {extra}" for extra in extras]
-	command = f"uv pip compile {' '.join(requirementsPaths)} {' '.join(extras_cmd)}"
+	command = (
+		f"uv pip compile {' '.join(requirementsPaths)} {' '.join(extras_cmd)} --index {index_url}"
+	)
 
 	result = subprocess.run(command, shell=True, capture_output=True, text=True, check=False)
 

licensecheck/resolvers/uv.py

@@ -1,6 +1,6 @@
 [project]
 name = "licensecheck"
-version = "2025"
+version = "2025.0.1"
 description = "Output the licenses used by dependencies and check if these are compatible with the project license"
 authors = [{ name = "FredHappyface" }]
 requires-python = ">=3.9"

pyproject.toml

@@ -1,9 +1,12 @@
 from __future__ import annotations
-import pytest
+
 from unittest.mock import MagicMock
-from licensecheck.types import PackageInfo, ucstr, License
-from licensecheck.packageinfo import PackageInfoManager
+
+import pytest
+
 from licensecheck.checker import check
+from licensecheck.packageinfo import PackageInfoManager
+from licensecheck.types import License, PackageInfo, ucstr
 
 
 @pytest.fixture
@@ -37,6 +40,7 @@ def test_check(
 		PackageInfo(name="PACKAGE_B", license=ucstr("GPL-3.0"), licenseCompat=False),
 	}
 	mock_package_info_manager.getPackages.return_value = mock_packages
+	mock_package_info_manager.pypi_search = "https://pypi.org/simple"
 
 	incompatible, packages = check(
 		requirements_paths=["requirements.txt"],