Skip to content

fastapi-mvc/copier-controller

Repository files navigation

Copier Controller

Copier template for scaffolding new controller upon fastapi-mvc project.

Quickstart

To use this template outside fastapi-mvc:

Prerequisites:

copier copy "https://github.com/fastapi-mvc/copier-controller.git" /path/to/your/new/project

Using Nix

nix-shell shell.nix
copier copy "https://github.com/fastapi-mvc/copier-controller.git" /path/to/your/new/project

Updating

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

./update.sh

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

  • Environment (pyproject.toml and poetry.lock)
  • README.md
  • Nix expression files
  • 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