Preparation for PyPI release (#25)

* metadata by pyproject.toml
* no ref to the bin file any more
* proper handling of missing args
* updating linter call list
* coverage seems to be broken
Signed-off-by: Christian Henkel <[email protected]>

.github/workflows/lint.yml

@@ -45,7 +45,7 @@ jobs:
         run: pip install .
       - uses: ricardochaves/[email protected]
         with:
-          python-root-list: "src/ test/ bin/ros_license_toolkit setup.py"
+          python-root-list: "src/ test/"
           use-pylint: false
           use-pycodestyle: true
           use-flake8: true

.github/workflows/pytest.yml

@@ -51,15 +51,15 @@ jobs:
         run: pip install .
       - uses: pavelzw/pytest-action@v2
         with:
-          custom-arguments: "--cov=src/ros_license_toolkit --cov-report=xml"
+          custom-arguments: "--cov=src/ros_license_toolkit"
           emoji: true
           verbose: true
           job-summary: true
-      - uses: orgoro/coverage@v3
-        with:
-          coverageFile: "coverage.xml"
-          token: ${{ secrets.GITHUB_TOKEN }}
-        if: github.event_name == 'pull_request'
+      # - uses: orgoro/coverage@v3
+      #   with:
+      #     coverageFile: "coverage.xml"
+      #     token: ${{ secrets.GITHUB_TOKEN }}
+      #   if: github.event_name == 'pull_request'
       # - uses: MishaKav/pytest-coverage-comment@main
       #   with:
       #     pytest-xml-coverage-path: "coverage.xml"

pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ros_license_toolkit"
+version = "1.0.0"
+description = "Checks ROS packages for correct license declaration."
+readme = "README.md"
+authors = [
+    {name = "Christian Henkel", email = "[email protected]"},
+]
+license = {file = "LICENSE"}
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Framework :: Robot Framework :: Tool",
+    "Topic :: Software Development :: Quality Assurance",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+keywords = ["ros", "license", "toolkit", "oss", "packages"]
+dependencies = [
+    "gitpython",
+    "rospkg",
+# TODO v32 changes things, see
+# https://github.com/nexB/scancode-toolkit/blob/develop/
+# CHANGELOG.rst#v3200---2023-05-23
+    "scancode-toolkit<=31.2.6",
+    "spdx-tools"
+]
+requires-python = ">=3.7"
+
+[project.urls]
+homepage = "https://github.com/boschresearch/ros_license_toolkit"
+repository = "https://github.com/boschresearch/ros_license_toolkit"
+
+[project.scripts]
+ros_license_toolkit = "ros_license_toolkit.main:main"

src/ros_license_toolkit/main.py

@@ -22,7 +22,7 @@
 import os
 import sys
 import timeit
-from typing import Sequence
+from typing import Optional, Sequence
 
 from ros_license_toolkit.checks import LicensesInCodeCheck
 from ros_license_toolkit.checks import LicenseTagExistsCheck
@@ -39,7 +39,7 @@
 from ros_license_toolkit.ui_elements import Verbosity
 
 
-def main(args: Sequence[str]) -> int:
+def main(args: Optional[Sequence[str]] = None) -> int:
     """Main entry point for the ros_license_toolkit CLI.
 
     :param args: the command line arguments, defaults to sys.argv[1:]

test/systemtest/test_all_packages.py

@@ -31,7 +31,7 @@ def test_all(self):
         Check that the output contains all package names.
         """
         with subprocess.Popen(
-            ["bin/ros_license_toolkit", "test/_test_data"],
+            ["ros_license_toolkit", "test/_test_data"],
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
         ) as process:

test/systemtest/test_documentation.py

@@ -29,7 +29,7 @@ class TestDocumentation(unittest.TestCase):
     def test_readme(self):
         """Check if the help text is up to date."""
         with subprocess.Popen(
-            ["bin/ros_license_toolkit", "-h"],
+            ["ros_license_toolkit", "-h"],
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
         ) as process:

test/systemtest/test_license_per_repo.py

@@ -45,7 +45,7 @@ def _test_repo(self, repo_name, pkg_names, license_name):
         make_repo(repo_path)
         # test
         with subprocess.Popen(
-            ["bin/ros_license_toolkit", repo_path],
+            ["ros_license_toolkit", repo_path],
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE
         ) as process:

test/systemtest/test_separate_pkgs.py

@@ -39,7 +39,7 @@ def test_deep_package_folder(self):
                 "test/_test_data/test_deep_package_folder/deeper/test_pkg_deep"
         ]:
             with subprocess.Popen(
-                ["bin/ros_license_toolkit", call_path],
+                ["ros_license_toolkit", call_path],
                 stdout=subprocess.PIPE,
                 stderr=subprocess.PIPE,
             ) as process:
@@ -105,7 +105,7 @@ def test_pkg_unknown_license(self):
         package.xml."""
         # using subprocess.Popen instead of main() to capture stdout
         with subprocess.Popen(
-            ["bin/ros_license_toolkit",
+            ["ros_license_toolkit",
              "test/_test_data/test_pkg_unknown_license"],
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE