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
@@ -116,6 +118,12 @@ coverage html
 
 ## Lint
 
+Install the dependencies:
+
+```sh
+pip install -e '.[lint]'
+```
+
 Update pre-commit hooks to the latest version:
 
 ```sh
@@ -142,6 +150,12 @@ ruff format
 
 ## Build
 
+Install the dependencies:
+
+```sh
+pip install -e '.[build]'
+```
+
 Generate distribution packages:
 
 ```sh
@@ -160,6 +174,14 @@ Install the package:
 pip install --index-url https://test.pypi.org/simple/ --no-deps python_package_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,11 +1,11 @@
-name: release-please
+name: release
 on:
   push:
     branches:
       - master
 
 jobs:
-  release-please:
+  release:
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -21,8 +21,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 +38,6 @@ jobs:
       - name: Use Python
         uses: actions/setup-python@v5
         with:
-          cache: pip
           python-version: 3
 
       - name: Install dependencies
@@ -48,4 +47,6 @@ 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 }}

pyproject.toml

@@ -1,5 +1,6 @@
 [project]
 name = "python_package_template"
+version = "0.0.0"
 authors = [
     { name="Mark", email="mark@remarkablemark.org" },
 ]
@@ -11,28 +12,36 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 license = "MIT"
-license-files = ["LICEN[CS]E*"]
-dynamic = ["version"]
+license-files = ["LICENSE"]
 dependencies = []
 
 [project.optional-dependencies]
 build = [
     "build==1.2.2.post1",
-    "pdoc==15.0.1",
     "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_package_template"
 Issues = "https://github.com/remarkablemark/python_package_template/issues"
 
 [tool.black]
 fast = true
+
+[tool.coverage.run]
+omit = [
+    "/tmp/*",
+]

src/python_package_template/__init__.py

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