0.1.0

Author: zigai

.gitignore

@@ -0,0 +1,61 @@
+# Copier Python Template
+
+My personal Copier template for Python projects.
+
+## Features
+
+* **Modern Python tooling** with [uv](https://docs.astral.sh/uv/) for dependency management and environment setup
+* **Pre-configured ```pyproject.toml```**
+* **Automated workflows** - [just](https://github.com/casey/just) commands for testing, linting, and building
+* **Code quality tools**: [ruff](https://docs.astral.sh/ruff/) for linting and formatting, pre-commit hooks
+* **Testing setup** with [pytest](https://docs.pytest.org/en/stable/) and [Hatch](https://hatch.pypa.io/latest/) for cross-version testing
+* **GitHub Actions integration**: optional workflows for testing and PyPI publishing
+* **Licenses from** [choosealicense.com](https://choosealicense.com/)
+* **Basic ```README.md```** with badges, installation instructions, and project structure
+
+## Requirements
+
+* Python 3.8+
+* [Copier](https://copier.readthedocs.io/) (`pip install copier` or `uv tool install copier`)
+* Git
+
+## Quick Setup
+
+Create a new Python project:
+
+```bash
+copier copy --trust "https://github.com/zigai/python-project-template.git" /path/to/your/project
+```
+
+or
+
+```bash
+copier copy --trust "gh:zigai/python-project-template" /path/to/your/project
+```
+
+## Generated Project Structure
+
+```
+your-project/
+├── your_package/
+│   └── __init__.py
+├── tests/
+│   └── test_your_package.py
+├── .github/workflows/          
+│   └── publish.yml
+├── pyproject.toml             
+├── README.md                  
+├── CONTRIBUTING.md             
+├── Justfile                    
+├── LICENSE                    
+└── .gitignore                  
+```
+
+## Similar Templates
+
+* [copier-uv](https://github.com/pawamoy/copier-uv)
+* [python-copier-template](https://github.com/DiamondLightSource/python-copier-template)
+
+## License
+
+This template is released under the [MIT License](https://github.com/zigai/python-project-template/blob/master/LICENSE).

README.md

@@ -0,0 +1,133 @@
+_templates_suffix: .jinja
+_envops:
+    autoescape: false
+_jinja_extensions:
+    - copier_templates_extensions.TemplateExtensionLoader
+    - extensions.py:GitDefaultsExtension
+    - extensions.py:PythonVersionExtension
+_subdirectory: "template"
+
+_templates:
+    - path: LICENSE.jinja
+      when: "{{ license != 'None' }}"
+package_name:
+    type: str
+    help: Python package name (must be a valid identifier)
+    placeholder: my_package
+
+repo_name:
+    type: str
+    help: Repository name (typically package name with dashes)
+    default: "{{ package_name | replace('_', '-') }}"
+
+author_name:
+    type: str
+    help: Author name
+    default: "{{ git_user_name }}"
+
+author_email:
+    type: str
+    help: Author email address
+    default: "{{ git_user_email }}"
+
+description:
+    type: str
+    help: Project description
+    placeholder: ""
+
+repository_url:
+    type: str
+    help: GitHub repository URL
+    default: "https://github.com/{{ github_username }}/{{ repo_name }}"
+
+python_min_version:
+    type: str
+    help: Minimum supported Python version
+    default: "3.10"
+    choices:
+        - "3.8"
+        - "3.9"
+        - "3.10"
+        - "3.11"
+        - "3.12"
+        - "3.13"
+        - "3.14"
+
+python_max_version:
+    type: str
+    help: Maximum supported Python version
+    default: "3.13"
+    choices:
+        - "3.8"
+        - "3.9"
+        - "3.10"
+        - "3.11"
+        - "3.12"
+        - "3.13"
+        - "3.14"
+
+python_default_version:
+    type: str
+    help: Default Python version for development
+    default: "3.12"
+    choices:
+        - "3.8"
+        - "3.9"
+        - "3.10"
+        - "3.11"
+        - "3.12"
+        - "3.13"
+        - "3.14"
+
+copyright_license:
+    type: str
+    help: Your project's license
+    default: None
+    choices:
+        No license: None
+        MIT License: MIT
+        Apache License 2.0: Apache-2.0
+        GNU General Public License v3.0 only: GPL-3.0
+        BSD 3-Clause "New" or "Revised" License: BSD-3-Clause
+        The Unlicense: Unlicense
+        zlib License: Zlib
+        Academic Free License v3.0: AFL-3.0
+        Artistic License 2.0: Artistic-2.0
+        BSD 2-Clause "Simplified" License: BSD-2-Clause
+        BSD 3-Clause Clear License: BSD-3-Clause-Clear
+        Boost Software License 1.0: BSL-1.0
+        Creative Commons Attribution 4.0 International: CC-BY-4.0
+        Creative Commons Attribution Share Alike 4.0 International: CC-BY-SA-4.0
+        Creative Commons Zero v1.0 Universal: CC0-1.0
+        Do What The F*ck You Want To Public License: WTFPL
+        Educational Community License v2.0: ECL-2.0
+        Eclipse Public License 1.0: EPL-1.0
+        Eclipse Public License 2.0: EPL-2.0
+        European Union Public License 1.1: EUPL-1.1
+        European Union Public License 1.2: EUPL-1.2
+        GNU Affero General Public License v3.0: AGPL-3.0
+        GNU General Public License v2.0 only: GPL-2.0
+        GNU Lesser General Public License v2.1 only: LGPL-2.1
+        GNU Lesser General Public License v3.0 only: LGPL-3.0
+        ISC License: ISC
+        LaTeX Project Public License v1.3c: LPPL-1.3c
+        Mozilla Public License 2.0: MPL-2.0
+        Microsoft Public License: MS-PL
+        Microsoft Reciprocal License: MS-RL
+        University of Illinois/NCSA Open Source License: NCSA
+        SIL Open Font License 1.1: OFL-1.1
+        Open Software License 3.0: OSL-3.0
+        PostgreSQL License: PostgreSQL
+
+readme_badges:
+    type: bool
+    help: Add badges to the README?
+    default: true
+
+publish_gh_action:
+    type: bool
+    help: Add a GitHub action for publishing to PyPi?
+    default: true
+
+_tasks:
+    - '{% if copyright_license == ''None'' %}python -c "import os; os.remove(''LICENSE'') if os.path.exists(''LICENSE'') else None"{% endif %}'

copier.yml

@@ -0,0 +1,79 @@
+import re
+import subprocess
+
+from jinja2.ext import Extension
+
+
+class GitDefaultsExtension(Extension):
+    def __init__(self, environment):
+        super().__init__(environment)
+        environment.globals["git_user_name"] = self._get_git_config("user.name")
+        environment.globals["git_user_email"] = self._get_git_config("user.email")
+        environment.globals["github_username"] = self._get_github_username()
+
+    def _get_git_config(self, key: str) -> str:
+        """Get a git configuration value.
+
+        Args:
+            key: The git config key to retrieve (e.g., 'user.name', 'user.email')
+
+        Returns:
+            The configuration value or empty string if not found
+        """
+        try:
+            result = subprocess.run(
+                ["git", "config", "--get", key],
+                capture_output=True,
+                text=True,
+                check=True,
+                shell=True,
+            )
+            return result.stdout.strip()
+        except (subprocess.CalledProcessError, FileNotFoundError):
+            return ""
+
+    def _get_github_username(self) -> str:
+        try:
+            result = subprocess.run(
+                ["git", "remote", "-v"],
+                capture_output=True,
+                text=True,
+                check=True,
+                shell=True,
+            )
+            for line in result.stdout.splitlines():
+                if "github.com" in line:
+                    # Extract username from URLs like:
+                    # [email protected]:username/repo.git
+                    # https://github.com/username/repo.git
+                    match = re.search(r"github\.com[:/]([^/]+)", line)
+                    if match:
+                        return match.group(1)
+
+        except (subprocess.CalledProcessError, FileNotFoundError):
+            return ""
+        return ""
+
+
+class PythonVersionExtension(Extension):
+    def __init__(self, environment):
+        super().__init__(environment)
+        environment.globals["py_versions_range"] = self._py_versions_range
+        environment.globals["py_classifiers"] = self._py_classifiers
+        environment.globals["black_target_versions"] = self._black_target_versions
+
+    def _py_versions_range(self, min_version: str, max_version: str) -> list[str]:
+        min_major, min_minor = map(int, min_version.split("."))
+        _, max_minor = map(int, max_version.split("."))
+        versions = []
+        for minor in range(min_minor, max_minor + 1):
+            versions.append(f"{min_major}.{minor}")
+        return versions
+
+    def _py_classifiers(self, min_version: str, max_version: str) -> list[str]:
+        versions = self._py_versions_range(min_version, max_version)
+        return [f"Programming Language :: Python :: {version}" for version in versions]
+
+    def _black_target_versions(self, min_version: str, max_version: str) -> list[str]:
+        versions = self._py_versions_range(min_version, max_version)
+        return [f"py{version.replace('.', '')}" for version in versions]

extensions.py

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.yaml, *.yml}]
+indent_size = 2

template/.editorconfig

@@ -0,0 +1,17 @@
+name: Lint
+on: [push, pull_request]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      - name: Set up Python
+        run: uv python install {{ python_default_version }}
+      - name: Install dependencies
+        run: uv sync --extra dev
+      - name: Run ruff
+        run: uv run ruff check .
+      - name: Run black
+        run: uv run black --check .

template/.github/workflows/lint.yml.jinja

@@ -0,0 +1,19 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv sync --extra test --python ${{ matrix.python-version }}
+      - name: Run pytest
+        run: uv run pytest -v

template/.github/workflows/tests.yml

@@ -0,0 +1,22 @@
+name: Upload Python Package
+on:
+  release:
+    types: [published]
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      - name: Set up Python
+        run: uv python install {{ python_default_version }}
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: __token__
+        {% raw %}
+          TWINE_PASSWORD: ${{ secrets.TOKEN }}
+        {% endraw %}
+        run: |
+          uv build
+          uv run --with twine twine upload dist/*