Rename the package (#3)

* Rename the package

* Disable publishing

* Target new package name with tools

* Adjust test expected output

Author: mbeacom

.github/workflows/publish.yaml

@@ -35,17 +35,18 @@ jobs:
           echo "Python Module Version: $MODULE_VERSION"
           if [[ "$TAG_VERSION" != "$MODULE_VERSION" ]]; then exit 1; fi
 
-      - name: Publish to PyPi
-        run: poetry publish --build
-        env:
-          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.POETRY_PYPI_TOKEN_PYPI }}
+      # TODO: Enable this to push to PyPi.
+      # - name: Publish to PyPi
+      #   run: poetry publish --build
+      #   env:
+      #     POETRY_PYPI_TOKEN_PYPI: ${{ secrets.POETRY_PYPI_TOKEN_PYPI }}
 
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
           discussion_category_name: announcements
           generate_release_notes: true
-          token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
-          files: |
-            dist/app-${{env.MODULE_VERSION}}.tar.gz
-            dist/app-${{env.MODULE_VERSION}}-py3-none-any.whl
+          # TODO: Update this to push PyPi package files to this release.
+          # files: |
+          #   dist/app-${{env.MODULE_VERSION}}.tar.gz
+          #   dist/app-${{env.MODULE_VERSION}}-py3-none-any.whl

app/__main__.py

@@ -1,12 +1,12 @@
 [tool.poetry]
 name = "app"
 version = "0.0.0"
-description = "This is an app"
+description = "This is a python template."
 authors = ["Mark Beacom <m@beacom.dev>"]
 readme = "README.md"
-packages = [{include = "app"}]
+packages = [{include = "python_template"}]
 license = "MIT"
-keywords = ["app", "cli"]
+keywords = ["app", "cli", "python", "template"]
 classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
@@ -23,7 +23,7 @@ include = [
 ]
 
 [tool.poetry.scripts]
-app = "app.cli:app"
+python-template = "python_template.cli:app"
 
 [tool.bandit]
 exclude_dirs = ["tests"]
@@ -47,14 +47,14 @@ black = "black ."
 check-black = {cmd = "black . --check --diff", help = "Validate styling with black"}
 check-isort = {cmd = "isort --check --profile=black .", help = "Validate import ordering with isort"}
 check-docstrings = "pydocstyle -e ."
-check-ruff = "ruff check app"
+check-ruff = "ruff check python_template"
 check = ["check-isort", "check-black"]
 lint = ["check-docstrings", "check-ruff"]
 fix = ["isort", "black", "ruff"]
-test = "pytest --cov=app --cov-report=xml --cov-report=term"
-ruff = "ruff check --fix app"
+test = "pytest --cov=python_template --cov-report=xml --cov-report=term"
+ruff = "ruff check --fix python_template"
 safety = "safety check"
-bandit = "bandit -r app"
+bandit = "bandit -r python_template"
 security = ["safety", "bandit"]
 # requires poethepoet outside of poetry.
 install = "poetry install"

pyproject.toml

@@ -0,0 +1,6 @@
+"""Perform the core python template workflow."""
+from __future__ import annotations
+
+from .cli import app
+
+app(prog_name="python-template")

app/__init__.py python_template/__init__.pyapp/__init__.py renamed to python_template/__init__.py

@@ -6,28 +6,28 @@
 import typer
 from rich.console import Console
 
-from app import __version__
+from python_template import __version__
 
-app = typer.Typer(help="This is an app")
+app = typer.Typer(help="This is a python template.")
 console = Console()
 
 
 def version_callback(value: bool) -> None:
     """Handle the version callback."""
     if value:
-        typer.secho(f"app version: {__version__}", fg=typer.colors.BRIGHT_BLUE, bold=True)
+        typer.secho(f"python-template version: {__version__}", fg=typer.colors.BRIGHT_GREEN, bold=True)
         raise typer.Exit()
 
 
 @app.command()
 def main(
     version: Optional[bool] = typer.Option(
-        None, "--version", callback=version_callback, is_eager=True, help="Display the current app version"
+        None, "--version", callback=version_callback, is_eager=True, help="Display the current python template version"
     ),
 ) -> None:
-    """Handle the main entry logic."""
+    """Run the main python template logic."""
     pass
 
 
 if __name__ == "__main__":  # pragma: no cover
-    app(prog_name="app")
+    app(prog_name="python-template")

python_template/__main__.py

@@ -3,7 +3,7 @@
 
 from typer.testing import CliRunner
 
-from app.cli import app
+from python_template.cli import app
 
 runner = CliRunner()
 
@@ -12,7 +12,7 @@ def test_entry_version_arg() -> None:
     """Test the entry method with version argument."""
     result = runner.invoke(app, ["--version"])
     assert result.exit_code == 0
-    assert "app version" in result.stdout
+    assert "python-template version" in result.stdout
 
 
 def test_entry_no_arg() -> None: