📦 [GH-71] Add PyPi GitHub Action releases (#72)

* feat: add pypi release to GitHub Action [#71]

* docs: update README [#71]

* chore: add version to docs and test docs step [#71]

Author: nickatnight

.github/workflows/main.yml

@@ -27,3 +27,32 @@ jobs:
       branch: "master"
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}
+
+  upload-release-to-pypi:
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: [create-release]
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          # Install a specific version of uv.
+          version: "0.7.18"
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install the project
+        run: uv sync
+
+      - name: Build the package
+        run: uv build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test.yml

@@ -33,9 +33,12 @@ jobs:
       - name: Install the project
         run: uv sync
 
-      - name: Run tests 📉
+      - name: Run unit tests 📉
         run: make pytest
 
+      - name: Tests sphinx 📚
+        run: make sphinx
+
   docker:
     strategy:
       fail-fast: false

README.md

@@ -2,7 +2,9 @@
     <a href="https://github.com/nickatnight/cookiecutter-fastapi-backend/actions">
         <img alt="GitHub Actions status" src="https://github.com/nickatnight/cookiecutter-fastapi-backend/actions/workflows/main.yml/badge.svg">
     </a>
-    <a href="https://github.com/nickatnight/cookiecutter-fastapi-backend/releases"><img alt="Release Status" src="https://img.shields.io/github/v/release/nickatnight/cookiecutter-fastapi-backend"></a>
+    <a href="https://pypi.org/project/cookiecutter-fastapi-backend/">
+        <img alt="PyPi Shield" src="https://img.shields.io/pypi/v/cookiecutter-fastapi-backend">
+    </a>
     <a href="https://github.com/nickatnight/cookiecutter-fastapi-backend/blob/master/LICENSE">
         <img alt="License Shield" src="https://img.shields.io/github/license/nickatnight/cookiecutter-fastapi-backend">
     </a>
@@ -16,11 +18,10 @@
 [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template to build and deploy fastapi backends to your favorite PaaS..batteries included.
 
 Supported PaaS's:
-- Render.com
+- Render
 - Platform.sh (Coming soon)
 - Porter (Coming soon)
 - Fly.io (Coming soon)
-- AWS (Coming soon)
 - DigitalOcean (Coming soon)
 
 ## Quickstart
@@ -29,9 +30,18 @@ Install the latest Cookiecutter if you haven't installed it yet (this requires C
 pip install cookiecutter
 ```
 
-Generate project:
+Generate project from GitHub template:
+
 ```sh
-cookiecutter https://github.com/nickatnight/cookiecutter-fastapi-backend.git
+$ cookiecutter gh:nickatnight/cookiecutter-fastapi-backend.git
+```
+
+Or from Python code:
+
+```python
+from cookiecutter.main import cookiecutter
+
+cookiecutter("gh:nickatnight/cookiecutter-fastapi-backend.git")
 ```
 
 ## Features
@@ -54,7 +64,7 @@ The input variables, with their default values (some auto generated) are:
 * `project_name`: The name of the project
 * `project_slug`: The development friendly name of the project. By default, based on the project name
 * `project_slug_db`: The database friendly name of the project. By default, based on the project name
-* `author_email`: The authors email...used for certbot
+* `author_email`: The authors email...for maintainer info in `pyproject.toml`
 * `py_version`: The version of Python to install. Options are `3.9`, `3.10`, and `3.11`
 * `db_container_name`: The name of the database container. Default `db`
 * `backend_container_name`: The name of the backend container. Default `backend`

docs/requirements.txt

@@ -396,7 +396,7 @@ text-unidecode==1.3 \
     --hash=sha256:1311f10e8b895935241623731c2ba64f4c455287888b18189350b67134a822e8 \
     --hash=sha256:bad6603bb14d279193107714b288be206cac565dfa49aa5b105294dd5c4aab93
     # via python-slugify
-tomli==2.2.1 ; python_full_version < '3.11' \
+tomli==2.2.1 \
     --hash=sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6 \
     --hash=sha256:02abe224de6ae62c19f090f68da4e27b10af2b93213d36cf44e6e1c5abd19fdd \
     --hash=sha256:286f0ca2ffeeb5b9bd4fcc8d6c330534323ec51b2f52da063b11c502da16f30c \

docs/source/conf.py

@@ -8,15 +8,22 @@
 from datetime import datetime
 from typing import Any
 
+import tomli
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 sys.path.insert(0, ".")
 sys.path.append(os.path.abspath("../.."))
 
 
+with open("../../pyproject.toml", "rb") as f:
+    toml_dict = tomli.load(f)
+
 project = "Cookiecutter FastAPI Backend"
 author = "Nick Kelly"
 copyright = datetime.today().strftime(f"%Y, {author}")
+release = toml_dict["project"]["version"]
+version = ".".join(release.split(".", 2)[:2])
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cookiecutter-fastapi-backend"
-version = "2.1.0"
+version = "2.2.0"
 description = "Cookiecutter template to build and deploy fastapi backends..batteries included"
 authors = [{ name = "nickatnight", email = "nialexanderke@proton.me" }]
 requires-python = ">=3.9"
@@ -9,13 +9,14 @@ dependencies = [
     "cookiecutter==2.6.0",
 ]
 classifiers = [
+    "Framework :: FastAPI",
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
-    "Topic :: Software Development :: Libraries :: Python Modules"
+    "Topic :: Software Development :: Code Generators"
 ]
 
 [project.urls]
@@ -33,11 +34,11 @@ dev = [
     "sphinx==7.4.7",
     "sphinx-rtd-theme==3.0.1",
     "sphinx-rtd-dark-mode==1.3.0",
+    "tomli==2.2.1",
     "typing-extensions==4.14.0"
 ]
 
 [tool.uv]
-package = false
 required-version = ">=0.7.18"
 
 [tool.ruff]