copier-python 0.1.4__tar.gz → 0.2.0__tar.gz

copier_python-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing to copier-python
+
+**Contributions are welcome!**
+
+Thank you for your time and interest in improving
+**copier-python**!
+
+## Contribution resources
+
+* **Web site**: **<https://smkent.github.io/copier-python>**
+  for general project information, usage, and development documentation
+* **Repository**: <https://github.com/smkent/copier-python>
+  for submitting pull requests
+* **Issue tracker**: <https://github.com/smkent/copier-python/issues>
+  for questions or bug reports

copier_python-0.2.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: copier-python
+Version: 0.2.0
+Summary: Copier template for Python projects with modern tooling
+Project-URL: Homepage, https://smkent.github.io/copier-python
+Project-URL: Repository, https://github.com/smkent/copier-python
+Project-URL: Issues, https://github.com/smkent/copier-python/issues
+Author-email: Stephen Kent <smkent@smkent.net>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# copier-python
+
+[Copier][copier] template for Python projects with modern tooling
+
+[![Copier][copier-badge]][copier]
+[![License](https://img.shields.io/github/license/smkent/copier-python)](https://github.com/smkent/copier-python/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/copier-python)](https://pypi.org/project/copier-python/)
+[![Python](https://img.shields.io/pypi/pyversions/copier-python)](https://pypi.org/project/copier-python/)
+[![GitHub stars](https://img.shields.io/github/stars/smkent/copier-python?style=social)](https://github.com/smkent/copier-python)
+
+## Quick start
+
+With [Astral's **uv**][uv] and [**Copier**][copier] (`uv tool install copier`)
+installed:
+
+```sh
+copier copy "gh:smkent/copier-python" /new/project/path
+```
+
+**[For more details, see the documentation!][docs-usage]**
+
+## Features
+
+* [Astral][astral] toolset: [**uv**][uv], [**ruff**][ruff], and [**ty**][ty]
+
+    [![uv][uv-badge]][uv]
+    [![ruff][ruff-badge]][ruff]
+    [![ty][ty-badge]][ty]
+
+* [**prek**][prek] for [pre-commit][pre-commit] compatible git hooks
+
+    [![prek][prek-badge]][prek]
+
+* Update automation with [**Renovate**][renovate] and
+  [**`copier update`**][copier-update]
+
+    [![Copier][copier-badge]][copier-update]
+    [![renovate][renovate-badge]][renovate]
+
+* [**PyPI package**][pypi] and [**container image**][ghcr-docs] release
+  automation via [**GitHub Actions**][github-actions]
+* [**pytest**][pytest] test framework with [**codecov.io**][codecovio] support
+* [**Zensical**][zensical] project documentation with automatic deployment to
+  [**GitHub Pages**][github-pages]
+* [**Poe the Poet**][poethepoet] for task shortcuts such as
+   `poe lint`, `poe test`
+
+## Credits
+
+This template was inspired by [pawamoy/copier-uv][copier-uv] and
+[ritwiktiwari/copier-astral][copier-astral] -- Thanks!
+
+[astral]: https://astral.sh
+[codecovio]: https://codecov.io
+[copier-astral]: https://ritwiktiwari.github.io/copier-astral/
+[copier-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json
+[copier-update]: https://copier.readthedocs.io/en/stable/updating/
+[copier-uv]: https://pawamoy.github.io/copier-uv/
+[copier]: https://copier.readthedocs.io
+[docs-usage]: https://smkent.github.io/copier-python/requirements/
+[ghcr-docs]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry
+[github-actions]: https://github.com/features/actions
+[github-pages]: https://pages.github.com
+[poethepoet]: https://poethepoet.natn.io/
+[pre-commit]: https://pre-commit.com/
+[prek-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json
+[prek]: https://prek.j178.dev/
+[pypi]: https://pypi.org
+[pytest]: https://docs.pytest.org
+[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot
+[renovate]: https://docs.renovatebot.com/
+[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[ruff]: https://docs.astral.sh/ruff/
+[ty-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json
+[ty]: https://docs.astral.sh/ty/
+[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json
+[uv]: https://docs.astral.sh/uv/
+[zensical]: https://zensical.org/

copier_python-0.2.0/README.md

@@ -0,0 +1,78 @@
+# copier-python
+
+[Copier][copier] template for Python projects with modern tooling
+
+[![Copier][copier-badge]][copier]
+[![License](https://img.shields.io/github/license/smkent/copier-python)](https://github.com/smkent/copier-python/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/copier-python)](https://pypi.org/project/copier-python/)
+[![Python](https://img.shields.io/pypi/pyversions/copier-python)](https://pypi.org/project/copier-python/)
+[![GitHub stars](https://img.shields.io/github/stars/smkent/copier-python?style=social)](https://github.com/smkent/copier-python)
+
+## Quick start
+
+With [Astral's **uv**][uv] and [**Copier**][copier] (`uv tool install copier`)
+installed:
+
+```sh
+copier copy "gh:smkent/copier-python" /new/project/path
+```
+
+**[For more details, see the documentation!][docs-usage]**
+
+## Features
+
+* [Astral][astral] toolset: [**uv**][uv], [**ruff**][ruff], and [**ty**][ty]
+
+    [![uv][uv-badge]][uv]
+    [![ruff][ruff-badge]][ruff]
+    [![ty][ty-badge]][ty]
+
+* [**prek**][prek] for [pre-commit][pre-commit] compatible git hooks
+
+    [![prek][prek-badge]][prek]
+
+* Update automation with [**Renovate**][renovate] and
+  [**`copier update`**][copier-update]
+
+    [![Copier][copier-badge]][copier-update]
+    [![renovate][renovate-badge]][renovate]
+
+* [**PyPI package**][pypi] and [**container image**][ghcr-docs] release
+  automation via [**GitHub Actions**][github-actions]
+* [**pytest**][pytest] test framework with [**codecov.io**][codecovio] support
+* [**Zensical**][zensical] project documentation with automatic deployment to
+  [**GitHub Pages**][github-pages]
+* [**Poe the Poet**][poethepoet] for task shortcuts such as
+   `poe lint`, `poe test`
+
+## Credits
+
+This template was inspired by [pawamoy/copier-uv][copier-uv] and
+[ritwiktiwari/copier-astral][copier-astral] -- Thanks!
+
+[astral]: https://astral.sh
+[codecovio]: https://codecov.io
+[copier-astral]: https://ritwiktiwari.github.io/copier-astral/
+[copier-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json
+[copier-update]: https://copier.readthedocs.io/en/stable/updating/
+[copier-uv]: https://pawamoy.github.io/copier-uv/
+[copier]: https://copier.readthedocs.io
+[docs-usage]: https://smkent.github.io/copier-python/requirements/
+[ghcr-docs]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry
+[github-actions]: https://github.com/features/actions
+[github-pages]: https://pages.github.com
+[poethepoet]: https://poethepoet.natn.io/
+[pre-commit]: https://pre-commit.com/
+[prek-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json
+[prek]: https://prek.j178.dev/
+[pypi]: https://pypi.org
+[pytest]: https://docs.pytest.org
+[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot
+[renovate]: https://docs.renovatebot.com/
+[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[ruff]: https://docs.astral.sh/ruff/
+[ty-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json
+[ty]: https://docs.astral.sh/ty/
+[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json
+[uv]: https://docs.astral.sh/uv/
+[zensical]: https://zensical.org/

{copier_python-0.1.4 → copier_python-0.2.0}/docs/contributing.md

@@ -1,4 +1,5 @@
 ---
+title: Contributing
 icon: lucide/code
 ---
 

copier_python-0.2.0/docs/development/requirements.md

@@ -0,0 +1,24 @@
+---
+title: Required software
+icon: lucide/bookmark-check
+---
+
+# Required software
+
+- [x] A [supported version][python-versions] of [**Python**][python]
+- [x] [**git** for verson control][git]
+- [x] [Astral's **uv** Python project manager][uv]: `pip install uv` or
+  [other supported method][uv-installation]
+- [x] [**Copier**][copier]: `uv tool install copier`
+- [x] [Poe the Poet][poethepoet] (recommended): `uv tool install poethepoet`
+
+    This provides `poe` without the `uv run` prefix,
+    e.g. `poe test` instead of `uv run poe test`
+
+[copier]: https://copier.readthedocs.io
+[git]: https://git-scm.com
+[poethepoet]: https://poethepoet.natn.io/
+[python-versions]: https://devguide.python.org/versions/
+[python]: https://python.org
+[uv-installation]: https://docs.astral.sh/uv/getting-started/installation/
+[uv]: https://docs.astral.sh/uv/

copier_python-0.2.0/docs/development/updates.md

@@ -0,0 +1,33 @@
+---
+title: Template updates
+icon: lucide/git-merge
+---
+
+# Applying copier-python template updates
+
+Copier can update your project with template changes that have occurred since
+the project was created.
+
+To apply updates, simply run in your project directory:
+
+```sh
+copier update
+```
+
+This will repeat the setup prompts, in case any prompts have been added or
+changed.
+
+!!! tip
+    To change template-provided features in your project, simply change your
+    answers in the update prompts.
+
+To apply updates without being prompted (reusing all previous answers), run:
+
+```sh
+copier update -l
+```
+
+When `copier update` is finished, view changes with `git status` and `git diff`.
+Resolve any conflicts, and then commit the result.
+
+[copier-update]: https://copier.readthedocs.io/en/stable/updating/

copier_python-0.2.0/docs/development/workflow.md

@@ -0,0 +1,49 @@
+---
+title: Development workflow
+icon: lucide/braces
+---
+
+# Project development workflow
+
+## Cloning the repository
+
+Run `poe setup` in new repository clones to enable git hooks:
+
+```sh
+git clone https://github.com/smkent/copier-python
+cd copier-python
+poe setup  # Enables git hooks
+```
+
+## Development tools
+
+* `poe lint`: Run formatters and static checks
+* `poe test`: Run tests
+
+The `lint` and `test` tasks can also be run as a single combined command with:
+
+```sh
+poe lt
+```
+
+### Test snapshots
+
+Many copier-python tests compare template-rendered files with saved snapshots.
+When templates are modified, the snapshots need to be updated. Update test
+snapshots by running:
+
+```sh
+poe snapup
+```
+
+## Documentation server
+
+Start the development server with:
+
+```sh
+poe docs
+```
+
+The documentation site will be served at **<http://localhost:8000>**.
+
+To use a different bind host/port, run `poe --help docs` for arguments info.

{copier_python-0.1.4 → copier_python-0.2.0}/docs/index.md

@@ -1,5 +1,8 @@
 ---
+title: Overview
 icon: lucide/book-open
+hide:
+  - path
 ---
 
 --8<-- "README.md"

{copier_python-0.1.4 → copier_python-0.2.0}/docs/license.md

@@ -1,4 +1,5 @@
 ---
+title: License
 icon: lucide/scale
 ---
 

copier_python-0.2.0/docs/project-creation.md

@@ -0,0 +1,72 @@
+---
+title: Creating a project
+icon: lucide/wand-sparkles
+---
+
+# Creating a new project
+
+## Choose a project name
+
+Select a name for your project that meets the
+[Python package naming criteria][pyproject-name]. This name will be used for
+`pip install` if you choose to [publish your project on PyPI][pypi].
+
+!!! tip
+    If you plan to publish your project on PyPI, ensure:
+
+    1. You have an [active PyPI account][pypi-login]
+    2. Your desired package name is available!
+
+## Create a GitHub repository
+
+[Create a repository on GitHub for your new project][github-new].
+Set **Repository name** to your chosen project name.
+
+## Generate new project from template
+
+1. In the directory where the new project should be created, run Copier:
+
+    ```sh
+    copier copy "gh:smkent/copier-python" ./project_name
+    ```
+
+    Copier will prompt for project information.
+    Answer the prompts to configure your project.
+    When complete, Copier will create your new project in `./project_name`.
+
+2. Change to the new project directory:
+
+    ```
+    cd ./project_name
+    ```
+
+## Initialize the project
+
+To complete project initialization, run:
+
+```sh
+poe init
+```
+
+This will:
+
+1. Create the local git repository
+2. Install dependencies and git hooks (same as `poe setup`)
+3. Create an initial commit with the newly created project contents
+4. Add your GitHub repository as the `origin` remote
+   (when `project_visibility: public`)
+
+## Push repository to GitHub
+
+Push your new project to your GitHub repository:
+
+```sh
+git push -u origin main
+```
+
+Your project's contents should now be visible on GitHub!
+
+[github-new]: https://github.com/new
+[pypi-login]: https://pypi.org/account/login/
+[pypi]: https://pypi.org
+[pyproject-name]: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#name

copier_python-0.2.0/docs/project-development.md

@@ -0,0 +1,39 @@
+---
+title: Development workflow
+icon: lucide/braces
+---
+
+# Project development workflow
+
+## Cloning the repository
+
+Run `poe setup` in new repository clones to enable git hooks:
+
+```sh
+git clone https://github.com/<github_user>/<project_name>
+cd project_name
+poe setup  # Enables git hooks
+```
+
+## Development tools
+
+* `poe lint`: Run formatters and static checks
+* `poe test`: Run tests
+
+The `lint` and `test` tasks can also be run as a single combined command with:
+
+```sh
+poe lt
+```
+
+## Documentation server
+
+Start the development server with:
+
+```sh
+poe docs
+```
+
+The documentation site will be served at **<http://localhost:8000>**.
+
+To use a different bind host/port, run `poe --help docs` for arguments info.

copier_python-0.2.0/docs/project-release.md

@@ -0,0 +1,25 @@
+---
+title: Releasing a project
+icon: lucide/rocket
+---
+
+# Releasing a project
+
+Release version numbers should follow [Semantic Versioning][semver].
+
+To create a new release, simply create and push a tag with the new release
+version number:
+
+```sh
+git tag vX.Y.Z  # for example, v1.2.3
+git push --tags
+```
+
+* A corresponding GitHub release will be created automatically.
+* If PyPI publishing is enabled, a release package will be built and uploaded to
+  PyPI.
+* If container image build and publishing is enabled, a container image will be
+  built and published to the [GitHub Container Registry (GHCR)][ghcr-docs].
+
+[ghcr-docs]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry
+[semver]: https://semver.org/

copier_python-0.2.0/docs/project-setup.md

@@ -0,0 +1,87 @@
+---
+title: Completing setup
+icon: lucide/settings
+---
+
+# Completing project setup
+
+!!! tip
+    If you selected **Enable documentation site** during project creation,
+    these instructions are also present in your new project along with links
+    directly to your project's specific settings pages! To view:
+
+    1. Start the local documentation server: `poe docs`
+    2. In your browser:
+
+        1. Open **<http://localhost:8000>**
+        2. Navigate to **Project Operations** → **One time setup**
+
+
+## GitHub repository
+
+[Repository Settings → General][github-settings-docs]:
+
+- [x] Allow merge commits
+- [ ] Allow squash merging
+- [ ] Allow rebase merging
+- [x] Automatically delete head branches
+
+Repository Settings → Branches → Add branch protection rule for the default branch
+(`main`):
+
+- [x] Restrict deletions
+- [x] Require a pull request before merging
+- [x] Block force pushes
+
+## Renovate
+
+Ensure the [Renovate app][renovate] is installed on your account, then enable
+it for your repository.
+
+## PyPI publishing
+
+!!! info "Only needed if your project will publish packages to PyPI"
+
+This template uses [trusted publishing][pypi-trusted-publishing] so no API
+tokens need to be stored as secrets.
+
+1. On PyPI, add a (pending) trusted publisher in your
+   [Trusted Publisher Management][pypi-publishing-settings] settings:
+     - Publisher: GitHub Actions
+     - Owner: `<your-github-user>`
+     - Repository: `<your-project-name>`
+     - Workflow: `release.yaml`
+     - Environment: `pypi`
+2. Create the `pypi` environment in the GitHub repository:
+   Repository Settings → Environments → New environment → `pypi`
+3. Publish a release by pushing a tag:
+   ```sh
+   git tag v0.1.0  # or your desired first version number
+   git push --tags
+   ```
+
+## Container registry (ghcr.io)
+
+!!! info "Only needed if your project will build and publish container images"
+
+Enable write access for Actions:
+
+Repository Settings → Actions → General → Workflow permissions
+→ Read and write permissions
+
+## GitHub Pages
+
+!!! info "Only needed if your project will publish the documentation site"
+
+Repository Settings → Pages → Source → GitHub Actions
+
+[copier]: https://copier.readthedocs.io
+[github-new]: https://github.com/new
+[github-settings-docs]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features
+[pypi-publishing-settings]: https://pypi.org/manage/account/publishing/
+[pypi-trusted-publishing]: https://docs.pypi.org/trusted-publishers/
+[pypi]: https://pypi.org
+[pypi-login]: https://pypi.org/account/login/
+[pyproject-name]: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#name
+[renovate]: https://github.com/apps/renovate
+[uv]: https://docs.astral.sh/uv/

copier_python-0.2.0/docs/project-updates.md

@@ -0,0 +1,33 @@
+---
+title: Template updates
+icon: lucide/git-merge
+---
+
+# Applying copier-python template updates
+
+Copier can update your project with template changes that have occurred since
+the project was created.
+
+To apply updates, simply run in your project directory:
+
+```sh
+copier update
+```
+
+This will repeat the setup prompts, in case any prompts have been added or
+changed.
+
+!!! tip
+    To change template-provided features in your project, simply change your
+    answers in the update prompts.
+
+To apply updates without being prompted (reusing all previous answers), run:
+
+```sh
+copier update -l
+```
+
+When `copier update` is finished, view changes with `git status` and `git diff`.
+Resolve any conflicts, and then commit the result.
+
+[copier-update]: https://copier.readthedocs.io/en/stable/updating/

copier_python-0.2.0/docs/releasing.md

@@ -0,0 +1,31 @@
+---
+title: Releasing a new version
+icon: lucide/rocket
+---
+
+# Releasing a new version
+
+Release version numbers should follow [Semantic Versioning][semver].
+
+To create a new release, simply create and push a tag with the new release
+version number:
+
+```sh
+git tag vX.Y.Z  # for example, v1.2.3
+git push --tags
+```
+
+* A corresponding [GitHub release][github-releases]
+  will be created automatically.
+
+    [![GitHub Release][github-release-badge]][github-release-latest]
+
+* A release package will be built and [uploaded to PyPI][pypi-project].
+
+    [![PyPI][pypi-badge]][pypi-project]
+
+[github-release-latest]: https://github.com/smkent/copier-python/releases/latest
+[github-releases]: https://github.com/smkent/copier-python/releases
+[github-release-badge]: https://img.shields.io/github/v/release/smkent/copier-python
+[pypi-badge]: https://img.shields.io/pypi/v/copier-python
+[pypi-project]: https://pypi.org/project/copier-python/

copier_python-0.2.0/docs/requirements.md

@@ -0,0 +1,24 @@
+---
+title: Required software
+icon: lucide/bookmark-check
+---
+
+# Required software
+
+- [x] A [supported version][python-versions] of [**Python**][python]
+- [x] [**git** for verson control][git]
+- [x] [Astral's **uv** Python project manager][uv]: `pip install uv` or
+  [other supported method][uv-installation]
+- [x] [**Copier**][copier]: `uv tool install copier`
+- [x] [Poe the Poet][poethepoet] (recommended): `uv tool install poethepoet`
+
+    This provides `poe` without the `uv run` prefix,
+    e.g. `poe test` instead of `uv run poe test`
+
+[copier]: https://copier.readthedocs.io
+[git]: https://git-scm.com
+[poethepoet]: https://poethepoet.natn.io/
+[python-versions]: https://devguide.python.org/versions/
+[python]: https://python.org
+[uv-installation]: https://docs.astral.sh/uv/getting-started/installation/
+[uv]: https://docs.astral.sh/uv/