refactor: tidy project and fix release workflow

Author: remarkablemark

.github/CONTRIBUTING.md

@@ -9,6 +9,7 @@
 - [Test](#test)
 - [Lint](#lint)
 - [Build](#build)
+- [Docs](#docs)
 - [Release](#release)
 
 </details>
@@ -51,8 +52,7 @@ source .venv/bin/activate
 Install the dependencies:
 
 ```sh
-pip install -e '.[build]'
-pip install -e '.[test]'
+pip install -e '.[lint]'
 ```
 
 Install pre-commit into your git hooks:
@@ -63,11 +63,7 @@ pre-commit install
 
 ## Develop
 
-Make your changes, add tests/documentation, and ensure tests pass:
-
-```sh
-pytest
-```
+Make your changes, add tests/documentation, and ensure [tests](#test) pass.
 
 Write a commit message that follows the [Conventional Commits](https://www.conventionalcommits.org/) specification:
 
@@ -92,6 +88,12 @@ Things that will improve the chance that your pull request will be accepted:
 
 ## Test
 
+Install the dependencies:
+
+```sh
+pip install -e '.[test]'
+```
+
 Run the tests:
 
 ```sh
@@ -128,6 +130,12 @@ python_cli_template --help
 
 ## Lint
 
+Install the dependencies:
+
+```sh
+pip install -e '.[lint]'
+```
+
 Update pre-commit hooks to the latest version:
 
 ```sh
@@ -154,6 +162,12 @@ ruff format
 
 ## Build
 
+Install the dependencies:
+
+```sh
+pip install -e '.[build]'
+```
+
 Generate the distribution packages:
 
 ```sh
@@ -178,6 +192,14 @@ Bundle the package with [PyInstaller](https://pyinstaller.org/):
 pyinstaller src/python_cli_template/cli.py --name python_cli_template
 ```
 
+## Docs
+
+Install the dependencies:
+
+```sh
+pip install -e '.[docs]'
+```
+
 Generate the docs with [pdoc](https://pdoc.dev/):
 
 ```sh

.github/workflows/release-please.yml .github/workflows/release.yml.github/workflows/release-please.yml renamed to .github/workflows/release.yml

@@ -1,17 +1,18 @@
-name: release-please
+name: release
 on:
   push:
     branches:
       - master
 
 jobs:
-  release-please:
+  release:
     runs-on: ubuntu-latest
     permissions:
       contents: write
       pull-requests: write
     outputs:
       release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
 
     steps:
       - name: Release Please
@@ -21,8 +22,8 @@ jobs:
           release-type: python
 
   publish:
-    needs: release-please
-    if: ${{ needs.release-please.outputs.release_created }}
+    needs: release
+    if: ${{ needs.release.outputs.release_created }}
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -38,7 +39,6 @@ jobs:
       - name: Use Python
         uses: actions/setup-python@v5
         with:
-          cache: pip
           python-version: 3
 
       - name: Install build
@@ -48,11 +48,13 @@ jobs:
         run: python -m build
 
       - name: Publish package to PyPI
-        uses: pypa/gh-action-pypi-publish@v1
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
 
   upload:
-    needs: release-please
-    if: ${{ needs.release-please.outputs.release_created }}
+    needs: release
+    if: ${{ needs.release.outputs.release_created }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -67,22 +69,34 @@ jobs:
       - name: Use Python
         uses: actions/setup-python@v5
         with:
-          cache: pip
           python-version: 3
 
       - name: Install dependencies
-        run: pip install pyinstaller
+        run: pip install -e '.[build]'
+
+      - name: Build executable
+        run: pyinstaller src/python_cli_template/cli.py --name python_cli_template --onefile --clean
+
+      - name: Compress executable
+        if: matrix.os != 'windows-latest'
+        working-directory: dist
+        run: zip archive.zip python_cli_template
 
-      - name: Build binary
-        run: pyinstaller src/python_cli_template/cli.py --name python_cli_template
+      - name: Compress executable
+        if: matrix.os == 'windows-latest'
+        working-directory: dist
+        run: Compress-Archive -Path python_cli_template.exe -Destination archive.zip
 
       - name: Upload Release Artifact
         shell: bash
+        working-directory: dist
         run: |
-          cd dist
           os=${{ matrix.os }}
           filename=${os%-*}.zip
-          zip -r $filename python_cli_template
+          if [[ $filename == 'ubuntu'* ]]; then
+            filename=linux.zip
+          fi
+          mv archive.zip $filename
           gh release upload ${{ needs.release.outputs.tag_name }} $filename
         env:
           GH_TOKEN: ${{ github.token }}

README.md

@@ -6,6 +6,14 @@
 
 🐍 Python CLI Template
 
+## Quick Start
+
+Greet name:
+
+```sh
+pipx run python_cli_template --name world
+```
+
 ## Prerequisites
 
 - [Python](https://www.python.org/)
@@ -19,24 +27,39 @@
 pipx install python_cli_template
 ```
 
-## Usage
+## CLI
 
-Greet name:
+### `--name`
+
+**Optional**: Name to greet. Defaults to `World`.
 
 ```sh
-python_cli_template --name world
+python_cli_template --name Alex
 ```
 
-Check version:
+### `--version`
+
+Show program's version number and exit:
 
 ```sh
-python_cli_template --version
+python_cli_template --version # python_cli_template -v
 ```
 
-See help:
+Show help message and exit:
 
 ```sh
-python_cli_template --help
+python_cli_template --help # python_cli_template -h
+```
+
+## Package
+
+Greet name:
+
+```py
+# script.py
+from python_cli_template import hello
+
+print(hello("Bob"))
 ```
 
 ## License

pyproject.toml

@@ -1,5 +1,6 @@
 [project]
 name = "python_cli_template"
+version = "0.0.0"
 authors = [
     { name="Mark", email="mark@remarkablemark.org" },
 ]
@@ -12,7 +13,6 @@ classifiers = [
 ]
 license = "MIT"
 license-files = ["LICEN[CS]E*"]
-dynamic = ["version"]
 dependencies = []
 
 [project.scripts]
@@ -24,22 +24,31 @@ python_cli_template = "python_cli_template.cli:main"
 [project.optional-dependencies]
 build = [
     "build==1.2.2.post1",
-    "pdoc==15.0.1",
     "pyinstaller==6.12.0",
     "twine==6.1.0",
 ]
-test = [
+docs = [
+    "pdoc==15.0.1",
+]
+lint = [
     "black==25.1.0",
-    "coverage==7.7.1",
     "isort==6.0.1",
     "pre-commit==4.2.0",
-    "pytest==8.3.5",
     "ruff==0.11.2",
 ]
+test = [
+    "coverage==7.7.1",
+    "pytest==8.3.5",
+]
 
 [project.urls]
 Homepage = "https://github.com/remarkablemark/python_cli_template"
 Issues = "https://github.com/remarkablemark/python_cli_template/issues"
 
 [tool.black]
 fast = true
+
+[tool.coverage.run]
+omit = [
+    "/tmp/*",
+]

src/python_cli_template/__init__.py

@@ -1,6 +1,4 @@
 """
-Python CLI Template
-
 .. include:: ../../README.md
 """
 

src/python_cli_template/cli.py

@@ -1,7 +1,6 @@
 from argparse import ArgumentParser
 
-from python_cli_template import __version__
-from python_cli_template.template import hello
+from python_cli_template import __version__, hello
 
 
 def main(argv: list[str] = None) -> None: