Split CLI into a separate wrapper package

Author: fopina

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 This project uses `uv`, so set up the virtualenv by running
 
 ```
-uv sync --dev --extra cli
+uv sync --dev
 ```
 
 Use `make test` to make sure all tests pass before pushing.

README.md

@@ -16,7 +16,7 @@ Multiple changes done on top of default openapi-generator:
 * Remove most of pydantic/schema validations due to inconsistencies with actual database schema/requirements (tracked in https://github.com/fopina/defectdojo-api-generated/issues/39)
 * *Iterator* methods for every *list* API method to handle pagination automatically
 * A nice CLI exposing all the API methods <3
-  * installed only as an extra, to keep everything clean when package is used as library only
+  * published as a separate package, to keep library-only installs free of console-script conflicts
 
 ## Example
 
@@ -49,7 +49,7 @@ pip install defectojo-api-generated
 > [uv](https://docs.astral.sh/uv/) recommended or [pipx](https://github.com/pypa/pipx)
 
 ```
-uv tool install 'defectojo-api-generated[cli]'
+uv tool install defectdojo-api-generated-cli
 ```
 
 ```
@@ -69,7 +69,7 @@ Commands:
 You can also skip tool install and just run it with:
 
 ```
-$ uvx 'defectojo-api-generated[cli]'
+$ uvx defectdojo-api-generated-cli
 Usage: dojo [OPTIONS] COMMAND [ARGS]...
 ...
 ```

packages/cli/.gitignore

@@ -0,0 +1,4 @@
+.venv/
+dist/
+src/*.egg-info/
+uv.lock

packages/cli/README.md

@@ -0,0 +1,5 @@
+# defectdojo-api-generated-cli
+
+Thin CLI wrapper distribution for [`defectdojo-api-generated`](https://pypi.org/project/defectdojo-api-generated/).
+
+This package owns the `dojo` console entrypoint and pulls in the optional CLI dependencies.

packages/cli/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=69.5.0,<80.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "defectdojo-api-generated-cli"
+version = "1.0.0"
+description = "CLI wrapper for defectdojo-api-generated"
+readme = "README.md"
+requires-python = ">=3.9,<4"
+dependencies = [
+    "classyclick==1.0.0",
+    "defectdojo-api-generated==1.0.0",
+    "jmespath>=1.0.1",
+]
+
+[project.scripts]
+dojo = "defectdojo_api_generated_cli.__main__:main"
+defectdojo-api-generated = "defectdojo_api_generated_cli.__main__:main"
+
+[project.urls]
+Homepage = "https://github.com/fopina/defectdojo-api-generated"
+
+[tool.uv.sources]
+defectdojo-api-generated = { path = "../.." }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["defectdojo_api_generated_cli"]

packages/cli/src/defectdojo_api_generated_cli/__init__.py

@@ -0,0 +1,3 @@
+"""Thin wrapper distribution for the DefectDojo CLI."""
+
+__version__ = '1.0.0'

packages/cli/src/defectdojo_api_generated_cli/__main__.py

@@ -0,0 +1,7 @@
+"""Entrypoint owned by the separate CLI distribution."""
+
+from defectdojo_api_generated.cli.__main__ import main
+
+
+if __name__ == '__main__':
+    main()

pyproject.toml

@@ -16,20 +16,11 @@ dependencies = [
     "typing-extensions>= 4.7.1",
 ]
 
-[project.optional-dependencies]
-cli = [
-    "classyclick==1.0.0",
-    "jmespath>=1.0.1",
-]
-
-[project.scripts]
-dojo = "defectdojo_api_generated.cli.__main__:main"
-# duplicated entrypoint to be able to use uvx without `--from`
-defectdojo-api-generated = "defectdojo_api_generated.cli.__main__:main"
-
 [dependency-groups]
 dev = [
     "build",
+    "classyclick==1.0.0",
+    "jmespath>=1.0.1",
     "mkdocs>=1.6.1",
     "mkdocs-click>=0.9.0",
     "pytest",
@@ -44,7 +35,7 @@ dev = [
 Homepage = "https://github.com/fopina/defectdojo-api-generated"
 
 [tool.setuptools.packages.find]
-include = ["defectdojo_api_generated*"]
+include = ["defectdojo_api_generated", "defectdojo_api_generated.*"]
 
 [tool.setuptools.dynamic]
 version = {attr = "defectdojo_api_generated.__version__"}

tests/unit/test_packaging.py

@@ -0,0 +1,42 @@
+import pathlib
+import re
+import tomllib
+import unittest
+
+import defectdojo_api_generated
+
+
+ROOT = pathlib.Path(__file__).resolve().parents[2]
+
+
+class TestPackagingLayout(unittest.TestCase):
+    def test_library_package_has_no_console_scripts(self):
+        pyproject = tomllib.loads((ROOT / 'pyproject.toml').read_text())
+
+        self.assertNotIn('scripts', pyproject['project'])
+
+    def test_cli_wrapper_package_owns_console_scripts(self):
+        pyproject = tomllib.loads((ROOT / 'packages' / 'cli' / 'pyproject.toml').read_text())
+
+        self.assertEqual(
+            pyproject['project']['scripts'],
+            {
+                'dojo': 'defectdojo_api_generated_cli.__main__:main',
+                'defectdojo-api-generated': 'defectdojo_api_generated_cli.__main__:main',
+            },
+        )
+
+    def test_cli_wrapper_version_matches_library_version(self):
+        wrapper_init = (ROOT / 'packages' / 'cli' / 'src' / 'defectdojo_api_generated_cli' / '__init__.py').read_text()
+        match = re.search(r"__version__ = '([^']+)'", wrapper_init)
+
+        self.assertIsNotNone(match)
+        self.assertEqual(match.group(1), defectdojo_api_generated.__version__)
+
+    def test_cli_wrapper_dependency_matches_library_version(self):
+        pyproject = tomllib.loads((ROOT / 'packages' / 'cli' / 'pyproject.toml').read_text())
+
+        self.assertIn(
+            f'defectdojo-api-generated=={defectdojo_api_generated.__version__}',
+            pyproject['project']['dependencies'],
+        )