✨ hatch-pip-compile

Author: juftin

.github/workflows/release.yaml

@@ -16,7 +16,7 @@ jobs:
                   fetch-depth: 2
                   ref: main
             - name: Setup Node.js
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
             - name: Release
               run: |
                   npm install --prefix .github/semantic_release/

README.md

@@ -18,7 +18,7 @@ cookiecutter gh:juftin/cookiecutter-python
 -   [hatch] for managing the project's virtual environment and development tools
 -   [ruff] for code formatting and linting
 -   [mypy] for type checking
--   [pip-tools] for dependency management + lockfile
+-   [hatch-pip-compile] for dependency management + lockfiles
 -   [pre-commit] for managing git hooks
 -   [GitHub Actions] for CI/CD
 -   [MkDocs] and [mkdocs-material] for documentation
@@ -85,22 +85,22 @@ hatch run docs:serve
 Once the server is running, you can view the documentation at
 [localhost:8080/contributing] or see a preview at [juftin.com/cookiecutter-python/contributing].
 
-[pre-commit]: https://pre-commit.com/
-[gitmoji]: https://gitmoji.dev/
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[gitmoji]: https://gitmoji.dev
 [semantic-release]: https://github.com/semantic-release/semantic-release
 [Cookiecutter]: https://github.com/cookiecutter/cookiecutter
-[hatch]: https://hatch.pypa.io/latest/
-[MkDocs]: https://www.mkdocs.org/
-[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/
+[hatch]: https://github.com/pypa/hatch
+[MkDocs]: https://github.com/mkdocs/mkdocs
+[mkdocs-material]: https://github.com/squidfunk/mkdocs-material
 [Github Actions]: https://github.com/features/actions
 [Github Pages]: https://pages.github.com/
 [juftin]: https://github.com/juftin
-[pipx]: https://pypa.github.io/pipx/
+[pipx]: https://github.com/pypa/pipx
 [PyPI]: https://pypi.org/
 [Docker Hub]: https://hub.docker.com/
-[pip-tools]: https://pip-tools.readthedocs.io/en/latest/
+[hatch-pip-compile]: https://github.com/juftin/hatch-pip-compile
 [GitHub CLI]: https://cli.github.com/
 [localhost:8080/contributing]: http://localhost:8080/contributing
-[ruff]: https://docs.astral.sh/ruff/
-[mypy]: https://mypy.readthedocs.io/
+[ruff]: https://github.com/astral/ruff/
+[mypy]: https://github.com/python/mypy
 [juftin.com/cookiecutter-python/contributing]: https://juftin.com/cookiecutter-python/contributing/

cookiecutter.json

@@ -8,7 +8,7 @@
     "full_name": "Justin Flannery",
     "email": "[email protected]",
     "github_username": "juftin",
-    "default_python_version": ["3.12", "3.11", "3.10", "3.9", "3.8"],
+    "default_python_version": ["3.11", "3.12", "3.10", "3.9", "3.8"],
     "default_branch": ["main", "master"],
     "license": ["MIT", "Apache-2.0", "GPL-3.0", "UNLICENSED"],
     "development_status": [

docs/index.md

@@ -18,7 +18,7 @@ cookiecutter gh:juftin/cookiecutter-python
 -   [hatch] for managing the project's virtual environment and development tools
 -   [ruff] for code formatting and linting
 -   [mypy] for type checking
--   [pip-tools] for dependency management + lockfile
+-   [hatch-pip-compile] for dependency management + lockfiles
 -   [pre-commit] for managing git hooks
 -   [GitHub Actions] for CI/CD
 -   [MkDocs] and [mkdocs-material] for documentation
@@ -83,23 +83,24 @@ hatch run docs:serve
 ```
 
 Once the server is running, you can view the documentation at
-[localhost:8080/contributing].
+[localhost:8080/contributing] or see a preview at [juftin.com/cookiecutter-python/contributing].
 
-[pre-commit]: https://pre-commit.com/
-[gitmoji]: https://gitmoji.dev/
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[gitmoji]: https://gitmoji.dev
 [semantic-release]: https://github.com/semantic-release/semantic-release
 [Cookiecutter]: https://github.com/cookiecutter/cookiecutter
-[hatch]: https://hatch.pypa.io/latest/
-[MkDocs]: https://www.mkdocs.org/
-[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/
+[hatch]: https://github.com/pypa/hatch
+[MkDocs]: https://github.com/mkdocs/mkdocs
+[mkdocs-material]: https://github.com/squidfunk/mkdocs-material
 [Github Actions]: https://github.com/features/actions
 [Github Pages]: https://pages.github.com/
 [juftin]: https://github.com/juftin
-[pipx]: https://pypa.github.io/pipx/
+[pipx]: https://github.com/pypa/pipx
 [PyPI]: https://pypi.org/
 [Docker Hub]: https://hub.docker.com/
-[pip-tools]: https://pip-tools.readthedocs.io/en/latest/
+[hatch-pip-compile]: https://github.com/juftin/hatch-pip-compile
 [GitHub CLI]: https://cli.github.com/
 [localhost:8080/contributing]: http://localhost:8080/contributing
-[ruff]: https://docs.astral.sh/ruff/
-[mypy]: https://mypy.readthedocs.io/
+[ruff]: https://github.com/astral/ruff/
+[mypy]: https://github.com/python/mypy
+[juftin.com/cookiecutter-python/contributing]: https://juftin.com/cookiecutter-python/contributing/

tests/example-project/.github/semantic_release/release_notes.hbs

@@ -23,10 +23,10 @@ jobs:
         - name: Set up Python
           uses: actions/setup-python@v4
           with:
-              python-version: "3.12"
-        - name: Install Dependencies
+              python-version: "3.11"
+        - name: Install Hatch
           run: |
-              python -m pip install --upgrade pip
+              python -m pip install -q --upgrade pip wheel
               python -m pip install -q hatch pre-commit
               hatch --version
         - name: Declare Version Variable

tests/example-project/.github/workflows/docker.yaml

@@ -15,12 +15,11 @@ jobs:
             - name: Set up Python Environment
               uses: actions/setup-python@v4
               with:
-                  python-version: "3.12"
-            - name: Install Python Dependencies
+                  python-version: "3.11"
+            - name: Install Hatch
               run: |
-                  python -m pip install --upgrade pip
+                  python -m pip install --upgrade pip wheel
                   python -m pip install -q hatch pre-commit
-                  hatch env create
                   hatch --version
             - name: Lint
               id: lint

tests/example-project/.github/workflows/lint.yaml

@@ -18,7 +18,7 @@ jobs:
             - name: Set up Python
               uses: actions/setup-python@v4
               with:
-                  python-version: "3.12"
+                  python-version: "3.11"
             - name: Install Hatch
               run: |
                   python -m pip install --upgrade pip
@@ -28,7 +28,7 @@ jobs:
               run: |
                   hatch build
             - name: Publish package on PyPI
-              uses: pypa/[email protected].10
+              uses: pypa/[email protected].11
               with:
                   user: __token__
                   password: ${{ secrets.PYPI_TOKEN }}
@@ -45,10 +45,10 @@ jobs:
             - name: Set up Python
               uses: actions/setup-python@v4
               with:
-                  python-version: "3.12"
+                  python-version: "3.11"
             - name: Install Hatch
               run: |
-                  python -m pip install --upgrade pip
+                  python -m pip install -q --upgrade pip wheel
                   python -m pip install -q hatch pre-commit
                   hatch --version
             - name: Set up QEMU

tests/example-project/.github/workflows/publish.yaml

@@ -21,11 +21,11 @@ jobs:
                   fetch-depth: 2
                   ref: main
             - name: Setup Node.js
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
             - name: Set up Python
               uses: actions/setup-python@v4
               with:
-                  python-version: "3.12"
+                  python-version: "3.11"
             - name: Install Hatch
               run: |
                   python -m pip install --upgrade pip
@@ -56,10 +56,10 @@ jobs:
             - name: Set up Python Environment
               uses: actions/setup-python@v4
               with:
-                  python-version: "3.12"
+                  python-version: "3.11"
             - name: Install Hatch
               run: |
-                  python -m pip install --upgrade pip
+                  python -m pip install --upgrade pip wheel
                   python -m pip install -q hatch pre-commit
                   hatch --version
             - name: Set Up GitHub Actions User

tests/example-project/.github/workflows/release.yaml

@@ -42,7 +42,7 @@ jobs:
                   python-version: ${{ matrix.python }}
             - name: Install Hatch
               run: |
-                  python -m pip install --upgrade pip
+                  python -m pip install -q --upgrade pip wheel
                   python -m pip install -q hatch pre-commit
                   hatch --version
             - name: Test Suite