GeezerVison is showing github.com — python-library-template/copier.yml at master · bedrock-python/python-library-template

Expand file tree

copier.yml

Copy path

More file actions

Latest commit

History

73 lines (61 loc) · 2.1 KB

copier.yml

Copy path

File metadata and controls

73 lines (61 loc) · 2.1 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

project_name:

type: str

help: "Display name (e.g. my-library)"

project_slug:

type: str

help: "PyPI package name, kebab-case (e.g. my-library)"

default: "{{ project_name | lower | replace(' ', '-') }}"

package_name:

type: str

help: "Python import name, snake_case (e.g. my_library)"

default: "{{ project_slug | replace('-', '_') }}"

project_description:

type: str

help: "One-line description for pyproject.toml and docs"

author_name:

type: str

help: "Author full name"

author_email:

type: str

help: "Author email"

github_org:

type: str

help: "GitHub organization or username"

default: "bedrock-python"

# The newest Python a render declares and runs its unit tests on. Not asked:

# raise it here once the libraries move to a new release.

python_max_version:

type: str

default: "3.14"

when: false

python_min_version:

type: str

help: "Minimum Python version (3.10 to {{ python_max_version }})"

default: "3.11"

validator: >-

{%- set minor = python_min_version.split(".")[-1] -%}

{%- if not python_min_version.startswith("3.") or not minor.isdigit()

or minor | int < 10 or minor | int > python_max_version.split(".")[-1] | int -%}

Use a 3.x version from 3.10 to {{ python_max_version }}

{%- endif -%}

initial_version:

type: str

help: "Initial version (keep 0.0.0 — Release Please cuts the first real release)"

default: "0.0.0"

_subdirectory: template

_jinja_extensions:

- jinja2_time.TimeExtension

_tasks:

# On a copy only: `copier update` runs tasks too, and a library taking a

# template update finished these steps long ago.

- command: >-

echo "Template generated. Next steps:

1. uv sync --group dev

2. uv run pre-commit install --hook-type commit-msg

3. Create the GitHub repo and push (branch: master)

4. After the first CI pass, from the template repo:

python scripts/setup_repo.py {{ github_org }}/{{ project_slug }}

5. Configure the PyPI Trusted Publisher at pypi.org

6. Add the CODECOV_TOKEN secret.

See NEW_LIBRARY_CHECKLIST.md for full details."

when: "{{ _copier_operation == 'copy' }}"