- Jinja 100%
| LICENSES | ||
| template | ||
| .editorconfig | ||
| CHANGELOG.md | ||
| copier.yaml | ||
| README.md | ||
| REUSE.toml | ||
scy's Python project template
This is a template repository for new (and existing, I guess) Python projects, for use with Copier.
It will set up:
- a uv-managed Python project
- with Ruff and mypy and optionally pytest
- some opinionated defaults regarding linting and code formatting
- licensing information for REUSE and PyPI
- a changelog
- a cute little readme
🌱 Status
I'm actively using this for setting up new projects. It's tailored to my personal needs; you might not want to copy it verbatim, but it can be a nice starting point for your own templates.
📚 Usage
If you have uv installed, you can create a new Python project like this:
uvx copier copy https://codeberg.org/scy/python-template.git target_directory
# answer some questions
cd target_directory
The questions should be self-explanatory.
The template is using tasks, which means you either have to allow it to run custom code, or run the task commands yourself.
They're not complicated, you can find them at the top of copier.yaml.
📃 License
This project is licensed under the terms of Creative Commons Zero v1.0 Universal.
The project also conforms to the REUSE Specification, version 3.3.
You can use the reuse tool to interpret the machine-readable licensing information.