This template (aka copier) sets up a structure for you to write a python package for TU Wien projects. It comes filled with a bunch of modern features from the python ecosystem.
- 🔧 CI pipelines for
Github ActionsandGitlab - 📜 Documentation from MyST
- ⚡ Fast environment and project management with uv
- 🎵 Task orchestration with Just
- ✒️ Preconfigured Licenses to choose from
- 📏 Testing setup with
pytest - 🎣 Pre-commit Hooks
- 🔍 Code Quality Assurance with ruff and ty
Note
This copier template tries to adhere to the Python Developer Tooling Handbook
To initialize a new repository with this copier template run the following command:
# if you have copier installed
copier copy https://github.com/TUW-GEO/cookiecutter-tuw-package <destination>
# or if you are using uv
uvx copier copy https://github.com/TUW-GEO/cookiecutter-tuw-package <destination>You will be prompted and then your repo will be setup.
One advantage of copier over cookiecutter is the ability to pull in template updates into an existing project:
copier updateRun this inside your generated project to apply changes from the template.
If you want to use the ApprovalTests.Python.GeoExtensions you can specify the geo approval test data root and the timestamp of the initial approval data data version.
This will add pytest.ini_options in the pyproject.toml file with the basic geo approval tests configurations.