miketheman / cookiecutter-fastapi-serverless

DRAFT - A cookiecutter template to generate a FastAPI service, deployable to AWS API Gateway & Lambda via the serverless framework.

cookiecutter-fastapi-template

A cookiecutter template to generate a FastAPI service, deployable to AWS API Gateway & Lambda via the serverless framework.

Why?

TODO: Short, but sweet description.

How?

TODO: User-facing generate new project, and then what to do next.

brew install cookiecutter
cookiecutter gh:miketheman/cookiecutter-fastapi-serverless

pipx run cookiecutter gh:miketheman/cookiecutter-fastapi-serverless

You will be prompted for some inputs which control the generated content, such as your full name, email, the project name, and license, amongst others. To view them all, see the cookiecutter.json file - you shouldn't have to change the file at all, only answer the prompts. The generate project won't contain this file.

Once complete, enter the template directory, and get things set up:

$ cd <project_slug>
$ git init
$ pipenv install --dev
$ pipenv run pytest

Also read the README.md in the project's directory, it'll have valuable information on how to continue!

Remember: this is all a starting point - feel free to change whatever you want, it's your project!

What?

What's included in this template? We've made some opinionated choices on what to include, so that you getting up and running faster

Included pieces, with links to their respecitve projects:

• .editorconfig
• .gitignore
• LICENSE file, based on your input
• [Pipenv] and Pipfile, set to Python 3.8
• pytest with plugins like black, flake8, isort
• uvicorn for running the service in local development

Who?

This project was originally authored by Mike Fiedler.

Contributing

TODO: Add contributing details.

License

Distributed under the terms of the MIT license, "cookiecutter-fastapi-template" is free and open source software. See LICENSE for details.