Repo is useful for simple and fast development to production with FastApi. Framework is the one of the asynchronous framework for Python, for documation please refer to FastAPI
FastAPI boilerplate supports Python version 3.5 and above. This boilerplate is using Gino-ORM for database connections and queries.
In order to use boilerplate for development we suggest you followings:
For development with pipenv:
pipenv shell
pipenv install or pip install -r requirements.txt
For development with pip:
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
Check this file and modife accordingly .env
source .env
For database migrations:
alembic revision --autogenerate
alembic upgrade heads
Last but not the least do the followings the you are ready to go:
uvicorn app.main:app --reload
add .env to gitignore
rm -rf .git
Fell free to open issue and send pull request.
Linux, MacOS