| name | rename-template |
| description | Replace the template placeholders (pypkg, pypkg-author, gpauloski/python-template) when starting a new project from this template. Use when asked to "rename the template", "set up a new project", or "replace pypkg". |
Rename template placeholders
The template uses placeholders that must be replaced for a new project. Ask the
user for their values first if not provided:
pypkg — the Python package/import name (e.g. mypkg).pypkg-author — the GitHub org/user or author handle.gpauloski/python-template — the new owner/repo slug.- author name, email, and description for
pyproject.toml.
Steps:
- Find all occurrences so nothing is missed:
git grep -n -e pypkg -e pypkg-author -e gpauloski/python-template
- Rename the package directory:
git mv pypkg <package_name>
- Replace the placeholders across the tree (review before running a bulk
sed). Key files: pyproject.toml, mkdocs.yml, README.md,
.github/**, docs/**, and the custom template
docs/templates/python/material/module.html.jinja.
- Update author, email, description, and URLs in
pyproject.toml, and the
<CONTACT_EMAIL> placeholder in .github/CODE_OF_CONDUCT.md.
- Verify nothing was missed and the project still works:
git grep -n pypkg
uv sync && pytest
