use pep 735 dependency groups instead of dev/test extras, use setup-uv (#32)

Author: tlambert03

.github/workflows/test.yml

@@ -17,6 +17,8 @@ jobs:
   test:
     name: ${{ matrix.platform }} py${{ matrix.python-version }}
     runs-on: ${{ matrix.platform }}
+    env:
+      UV_PYTHON: ${{ matrix.python-version }}
     strategy:
       fail-fast: false
       matrix:
@@ -25,16 +27,5 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install pytest build check-manifest pre-commit copier tomli
-
-      - name: Test
-        run: pytest tests -v --color=yes
+      - uses: astral-sh/setup-uv@v6
+      - run: uv run pytest tests -v --color=yes

.gitignore

@@ -129,3 +129,4 @@ dmypy.json
 .pyre/
 pyrepo
 .vscode/
+uv.lock

project/.github/workflows/ci.yml.jinja

@@ -2,10 +2,8 @@ name: CI
 
 on:
   push:
-    branches:
-      - main
-    tags:
-      - "v*"
+    branches: [main]
+    tags: [v*]
   pull_request:
   workflow_dispatch:
   {% if test_pre_release -%}
@@ -24,8 +22,6 @@ concurrency:
 jobs:
 {%- if mode != 'simple' %}
   check-manifest:
-    # check-manifest is a tool that checks that all files in version control are
-    # included in the sdist (unless explicitly excluded)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -34,6 +30,10 @@ jobs:
   test:
     name: ${{ matrix.platform }} (${{ matrix.python-version }})
     runs-on: ${{ matrix.platform }}{% endraw %}
+    {%- if test_pre_release %}
+    env:
+      UV_PRERELEASE: {% raw %}${{ github.event_name == 'schedule' && 'allow' || 'if-necessary-or-explicit' }}{% endraw %}
+    {%- endif %}
     strategy:
       fail-fast: false
       matrix:
@@ -48,24 +48,16 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: 🐍 Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: astral-sh/setup-uv@v6
         with:
           python-version: ${{ matrix.python-version }}
-          cache-dependency-path: "pyproject.toml"
-          cache: "pip"
+          enable-cache: true
 
       - name: Install Dependencies
-        run: |
-          python -m pip install -U pip
-          {% endraw %}{%- if test_pre_release -%}
-          # if running a cron job, we add the --pre flag to test against pre-releases
-          {% raw %}python -m pip install .[test] ${{ github.event_name == 'schedule' && '--pre' || ''  }}{% endraw %}
-          {%- else -%}
-          python -m pip install .[test]
-          {%- endif %}
+        run: uv sync --no-dev --group test
 
       - name: 🧪 Run Tests
-        run: pytest --color=yes --cov --cov-report=xml --cov-report=term-missing
+        run: uv run pytest --cov --cov-report=xml --cov-report=term-missing{% endraw %}
       {%- if test_pre_release %}{% raw %}
 
       # If something goes wrong with --pre tests, we can open an issue in the repo
@@ -84,14 +76,25 @@ jobs:
       {%- endif %}{% raw %}
 
       - name: Coverage
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
+        # with:
+        #   token: ${{ secrets.CODECOV_TOKEN }}
 
-  deploy:
-    name: Deploy
+  build-and-inspect-package:
+    name: Build & inspect package.
     needs: test
-    if: success() && startsWith(github.ref, 'refs/tags/'){% endraw %}{%- if test_pre_release %}{% raw %} && github.event_name != 'schedule'{% endraw %}{% endif %}{% raw %}
     runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: hynek/build-and-inspect-python-package@v2
 
+  upload-to-pypi:
+    name: Upload package to PyPI
+    needs: build-and-inspect-package
+    if: success() && startsWith(github.ref, 'refs/tags/'){% endraw %}{%- if test_pre_release %}{% raw %} && github.event_name != 'schedule'{% endraw %}{% endif %}{% raw %}
+    runs-on: ubuntu-latest
     permissions:
       # IMPORTANT: this permission is mandatory for trusted publishing on PyPi
       # see https://docs.pypi.org/trusted-publishers/
@@ -100,24 +103,14 @@ jobs:
       contents: write
 
     steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: 🐍 Set up Python
-        uses: actions/setup-python@v4
+      - name: Download built artifact to dist/
+        uses: actions/download-artifact@v4
         with:
-          python-version: "3.x"
-
-      - name: 👷 Build
-        run: |
-          python -m pip install build
-          python -m build
-
+          name: Packages
+          path: dist
       - name: 🚢 Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
-
-      - uses: softprops/action-gh-release@v1
+      - uses: softprops/action-gh-release@v2
         with:
           generate_release_notes: true
           files: './dist/*'

project/README.md.jinja

@@ -7,3 +7,32 @@
 [![codecov](https://codecov.io/gh/{{github_username}}/{{project_name}}/branch/main/graph/badge.svg)](https://codecov.io/gh/{{github_username}}/{{project_name}})
 
 {{project_short_description}}
+
+## Development
+
+The easiest way to get started is to use the [github cli](https://cli.github.com)
+and [uv](https://docs.astral.sh/uv/getting-started/installation/):
+
+```sh
+{% if github_username -%}
+gh repo fork {{github_username}}/{{project_name}} --clone
+# or just
+# gh repo clone {{github_username}}/{{project_name}}
+{%- else -%}
+# clone the repo or your fork locally
+{%- endif %}
+cd {{project_name}}
+uv sync
+```
+
+Run tests:
+
+```sh
+uv run pytest
+```
+
+Lint files:
+
+```sh
+uv run pre-commit run --all-files
+```

project/pyproject.toml.jinja

@@ -62,22 +62,9 @@ classifiers = [
 dependencies = []
 
 # https://peps.python.org/pep-0621/#dependencies-optional-dependencies
-# "extras" (e.g. for `pip install .[test]`)
-[project.optional-dependencies]
-# add dependencies used for testing here
-test = ["pytest", "pytest-cov"]
-# add anything else you like to have in your dev environment here
-dev = [
-    "ipython",
-    {%- if use_mypy %}
-    "mypy",{%- endif %}
-    "pdbpp",  # https://github.com/pdbpp/pdbpp
-    {%- if use_pre_commit %}
-    "pre-commit",{%- endif %}
-    "rich",  # https://github.com/Textualize/rich
-    {%- if use_ruff %}
-    "ruff",{%- endif %}
-]
+# add dependencies for "extra" features here.  Not dev dependencies.
+# [project.optional-dependencies]
+# name = ["dependency"]
 
 [project.urls]
 {% if github_username -%}
@@ -97,14 +84,35 @@ repository = "https://github.com/{{github_username}}/{{project_name}}"
 # [project.entry-points."some.group"]
 # tomatoes = "{{module_name}}:main_tomatoes"
 
+# https://peps.python.org/pep-0735/
+# setup with `uv sync` or `pip install -e . --group dev`
+[dependency-groups]
+test = ["pytest", "pytest-cov"]
+dev = [
+    { include-group = "test" },
+    "ipython",
+    {%- if use_mypy %}
+    "mypy",{%- endif %}
+    "pdbpp",  # https://github.com/pdbpp/pdbpp
+    {%- if use_pre_commit %}
+    "pre-commit-uv",{%- endif %}
+    "rich",  # https://github.com/Textualize/rich
+    {%- if use_ruff %}
+    "ruff",{%- endif %}
+]
+
+[tool.uv.sources]
+{{project_name}} = { workspace = true }
+
 {% if use_ruff -%}
 # https://docs.astral.sh/ruff
 [tool.ruff]
 line-length = 88
 target-version = "py3{{ minimum_python }}"
 src = ["src"]
+fix = true
+# unsafe-fixes = true
 
-# https://docs.astral.sh/ruff/rules
 [tool.ruff.lint]
 pydocstyle = { convention = "numpy" }
 select = [
@@ -119,7 +127,7 @@ select = [
     "B",    # flake8-bugbear
     "A001", # flake8-builtins
     "RUF",  # ruff-specific rules
-    "TCH",  # flake8-type-checking
+    "TC",   # flake8-type-checking
     "TID",  # flake8-tidy-imports
 ]
 ignore = [
@@ -128,6 +136,7 @@ ignore = [
 
 [tool.ruff.lint.per-file-ignores]
 "tests/*.py" = ["D", "S"]
+"docs/*.py" = ["D", "A"]
 
 # https://docs.astral.sh/ruff/formatter/
 [tool.ruff.format]
@@ -136,6 +145,13 @@ skip-magic-trailing-comma = false  # default is false
 {%- endif -%}
 {%- if use_mypy %}
 
+# https://docs.pytest.org/
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = ["--color=yes"]
+testpaths = ["tests"]
+filterwarnings = ["error"]
+
 # https://mypy.readthedocs.io/en/stable/config_file.html
 [tool.mypy]
 files = "src/**/"
@@ -144,19 +160,14 @@ disallow_any_generics = false
 disallow_subclassing_any = false
 show_error_codes = true
 pretty = true
+# plugins = ["pydantic.mypy"]
 
 # # module specific overrides
 # [[tool.mypy.overrides]]
 # module = ["numpy.*",]
 # ignore_errors = true
 {%- endif %}
 
-# https://docs.pytest.org/
-[tool.pytest.ini_options]
-minversion = "7.0"
-testpaths = ["tests"]
-filterwarnings = ["error"]
-
 # https://coverage.readthedocs.io/
 [tool.coverage.report]
 show_missing = true
@@ -165,6 +176,7 @@ exclude_lines = [
     "if TYPE_CHECKING:",
     "@overload",
     "except ImportError",
+    "raise AssertionError",
     "\\.\\.\\.",
     "raise NotImplementedError()",
     "pass",
@@ -181,4 +193,9 @@ ignore = [
     ".pre-commit-config.yaml",
     ".ruff_cache/**/*",
     "tests/**/*",
+    "uv.lock",
 ]
+
+# https://github.com/crate-ci/typos/blob/master/docs/reference.md
+[tool.typos.default]
+extend-ignore-identifiers-re = []

project/tests/test_{{module_name}}.py.jinja

@@ -1,2 +1,5 @@
-def test_something():
-    pass
+import {{module_name}}
+
+
+def test_imports_with_version():
+    assert isinstance({{module_name}}.__version__, str)

project/{% if use_pre_commit %}.pre-commit-config.yaml{% endif %}.jinja

@@ -9,19 +9,19 @@ ci:
 
 repos:
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.22
+    rev: v0.24.1
     hooks:
       - id: validate-pyproject
 {%- if use_ruff %}
 
   - repo: https://github.com/crate-ci/typos
-    rev: v1.24.6
+    rev: v1.32.0
     hooks:
       - id: typos
         args: [--force-exclude]  # omitting --write-changes
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.2
+    rev: v0.11.10
     hooks:
       - id: ruff
         args: [--fix]  # may also add '--unsafe-fixes'
@@ -30,7 +30,7 @@ repos:
 {%- if use_mypy %}
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.13.0
+    rev: v1.15.0
     hooks:
       - id: mypy
         files: "^src/"

pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "pyrepo-copier"
+version = "0.1.0"
+readme = "README.md"
+license = { text = "BSD-3-Clause" }
+
+[tool.mypy]
+disallow_any_decorated = false
+disallow_any_generics = true
+disallow_any_unimported = false
+disallow_subclassing_any = false
+disallow_untyped_calls = true
+disallow_untyped_defs = false
+ignore_missing_imports = true
+warn_unused_ignores = true
+warn_return_any = true
+
+[tool.pytest.ini_options]
+norecursedirs = "{{project_name}}"
+
+[dependency-groups]
+dev = [
+    "check-manifest>=0.50",
+    "copier>=9.7.1",
+    "pre-commit>=4.2.0",
+    "pytest>=8.3.5",
+    "tomli>=2.2.1",
+]