diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 3e1cc48..29906c6 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -76,7 +76,7 @@ jobs: Packages uploaded to ${{ inputs.repository }} \`\`\` pip install${INDEX} defectdojo-api-generated==${{ inputs.version }} - pip install${INDEX} defectdojo-api-generated-cli==${{ inputs.version }} + pip install${INDEX} defectdojo-cli==${{ inputs.version }} \`\`\` EOF if [ "${{ inputs.repository }}" != "pypi" ]; then @@ -84,14 +84,14 @@ jobs: Run with \`uvx\` \`\`\` uvx --with 'defectdojo-api-generated @ https://test-files.pythonhosted.org/packages/source/d/defectdojo-api-generated/defectdojo_api_generated-${{ inputs.version }}.tar.gz' \\ - 'defectdojo-api-generated-cli @ https://test-files.pythonhosted.org/packages/source/d/defectdojo-api-generated-cli/defectdojo_api_generated_cli-${{ inputs.version }}.tar.gz' + 'defectdojo-cli @ https://test-files.pythonhosted.org/packages/source/d/defectdojo-cli/defectdojo_cli-${{ inputs.version }}.tar.gz' \`\`\` EOF else cat <> ${GITHUB_STEP_SUMMARY} Run with \`uvx\` \`\`\` - uvx defectdojo-api-generated-cli==${{ inputs.version }} + uvx defectdojo-cli==${{ inputs.version }} \`\`\` EOF fi diff --git a/README.md b/README.md index 5c1e597..2797f75 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,14 @@ 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 - * published as a separate package, to keep library-only installs free of console-script conflicts + * published as `defectdojo-cli`, a separate package to keep library-only installs free of console-script conflicts ## Example ### Library ``` -pip install defectojo-api-generated +pip install defectdojo-api-generated ``` @@ -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 defectdojo-api-generated-cli +uv tool install defectdojo-cli ``` ``` @@ -69,7 +69,7 @@ Commands: You can also skip tool install and just run it with: ``` -$ uvx defectdojo-api-generated-cli +$ uvx defectdojo-cli Usage: dojo [OPTIONS] COMMAND [ARGS]... ... ``` diff --git a/docs/cli.md b/docs/cli.md index 448b758..337987e 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -7,7 +7,7 @@ This page provides documentation for the command line tool `dojo`. > [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-cli ``` ::: mkdocs-click diff --git a/packages/cli/README.md b/packages/cli/README.md index c507e5b..8a7bd70 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -1,5 +1,9 @@ -# defectdojo-api-generated-cli +# defectdojo-cli -Thin CLI wrapper distribution for [`defectdojo-api-generated`](https://pypi.org/project/defectdojo-api-generated/). +CLI for [DefectDojo](https://github.com/DefectDojo/django-DefectDojo) using +[`defectdojo-api-generated`](https://pypi.org/project/defectdojo-api-generated/). This package owns the `dojo` console entrypoint and pulls in the optional CLI dependencies. + +Documentation is available at +. diff --git a/packages/cli/pyproject.toml b/packages/cli/pyproject.toml index 7aaae87..00cfdbc 100644 --- a/packages/cli/pyproject.toml +++ b/packages/cli/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=69.5.0,<80.0.0"] build-backend = "setuptools.build_meta" [project] -name = "defectdojo-api-generated-cli" +name = "defectdojo-cli" version = "1.0.0" description = "CLI wrapper for defectdojo-api-generated" readme = "README.md" @@ -16,7 +16,7 @@ dependencies = [ [project.scripts] dojo = "defectdojo_api_generated.cli.__main__:main" -defectdojo-api-generated-cli = "defectdojo_api_generated.cli.__main__:main" +defectdojo-cli = "defectdojo_api_generated.cli.__main__:main" [project.urls] Homepage = "https://github.com/fopina/defectdojo-api-generated" diff --git a/tests/unit/test_packaging.py b/tests/unit/test_packaging.py index 1bd3de2..de491f8 100644 --- a/tests/unit/test_packaging.py +++ b/tests/unit/test_packaging.py @@ -24,7 +24,7 @@ def test_cli_distribution_points_console_scripts_to_library_entrypoint(self): pyproject['project']['scripts'], { 'dojo': 'defectdojo_api_generated.cli.__main__:main', - 'defectdojo-api-generated-cli': 'defectdojo_api_generated.cli.__main__:main', + 'defectdojo-cli': 'defectdojo_api_generated.cli.__main__:main', }, )