cookiecutter-fastapi

GitHub forks GitHub Repo stars GitHub last commit

Features

  • [x] For FastAPI 0.104.1
  • [x] Works with Python 3.11
  • [x] Config for Serverless
  • [x] Config for MySQL/SQLlite
  • [x] Async
  • [x] Mkdocs
  • [x] Basic Auth JWT
  • [ ] Templates
  • [ ] Crud

Usage

First install cookiecutter

pip install cookiecutter

Now run this command to clone

cookiecutter https://github.com/FernandoCelmer/cookiecutter-fastapi

Now just fill in some information for the cookiecutter to do its work and replace it in the project.

[1/18] repo_name (cookiecutter-fastapi): cookiecutter-fastapi
[2/18] project_name (FastAPI Template): Test FastAPI 
[3/18] project_slug (test_fastapi): 
[4/18] description (Amazing project with FastAPI!): Amazing API
[5/18] author_name (Fernando Celmer): Fernando Celmer
[6/18] domain_name (fernandocelmer.com): fernandocelmer.com
[7/18] email (fernando-celmer@fernandocelmer.com): email@fernandocelmer.com
[8/18] version (0.1.0): 
[9/18] Select open_source_license
    1 - MIT
    2 - BSD
    3 - Apache Software License 2.0
    4 - Not open source
    Choose from [1/2/3/4] (1): 1
[10/18] Select id_type
    1 - UUID
    2 - Integer
    Choose from [1/2] (1): 1
[11/18] url_documentation (#): 
[12/18] url_source_code (#): 
[13/18] use_async (y): 
[14/18] use_mkdocs (y): 
[15/18] use_serverless (y): 
[16/18] use_templates (y): 
[17/18] use_auth (y):
[18/18] github_action_code_scan (y):

Commit Style

  • ⚙️ FEATURE
  • 📝 PEP8
  • 📌 ISSUE
  • 🪲 BUG
  • 📘 DOCS
  • 📦 PyPI
  • ❤️️ TEST
  • ⬆️ CI/CD
  • ⚠️ SECURITY

License

This project is licensed under the terms of the MIT license.