Copier template for fastapi projects.
- 🚀 Basic fastapi setup
- 📅 API versioning using fastapi-versionizer
- 🚦 Pre-defined HTTP status code error models
- 🔍 Sorting and filtering query dependencies
- 📚 Pagination model with built-in page calculation
- 📦 Poetry setup with a pre-defined pyproject.toml
- 🔁 Continuous integration (CI) pipelines for Github Actions and GitLab CI/CD
- 🐳 Docker support with build and publish pipelines
- ⚙️ Settings management using pydantic-settings
- 🗄️ Database support with sqlmodel and mysql, postgres or sqlite configuration
▶️ alembic database migrations- 🏃 poethepoet task runner
- 🪝 pre-commit hooks
- 🔍 pylint code linter
- 🏁 mypy static type checker
- 🧪 pytest unit tests
- 🛡️ bandit code security check
- 🎨 autopep8 and pydocstringformatter code formatter and styling
- 🆚 VSCode configuration
First install copier:
(from the official installation documentation)
pip install copierMake sure the requirements are met, then:
copier copy --trust "https://github.com/worldworm/copier-fastapi.git" .To update a template after creating a project, run:
copier update --trust -a .project/.copier-answers.fastapi.yml .In addition to this template, there are a number of other Copier templates available. For an overview of all available templates, visit the Templates Showcase repository.