Skip to content

rszamszur/copier-python-base

Repository files navigation

Copier Python Base

Copier template for scaffolding new Python base project using fastapi-mvc.

Quickstart

To use this template outside fastapi-mvc:

Prerequisites:

copier copy "https://github.com/rszamszur/copier-python-base" /path/to/your/new/python_base

Using Nix

Prerequisites:

nix develop
copier copy "https://github.com/rszamszur/copier-python-base" /path/to/your/new/python_base

Updating

To update your generator with the changes from the upstream run:

./update.sh
# Or
nix run .#update

This action will not update/override your template and its configuration, but rather generators common files:

  • Nix expression files
  • README.md
  • dotfiles
  • LICENSE

List of excluded files/paths:

  • template/**
  • copier.yml
  • *.py
  • CHANGELOG.md

Lastly, you can pass extra copier CLI options should you choose:

./update.sh -x README.md --vcs-ref=custom_branch
# Or
nix run .#update -- -x README.md --vcs-ref=custom_branch