fastapi-sqlalchemy

A RESTful API service template built with fastapi. Use sqlalchemy to query and postgreSQL as database storage.

Development

Prerequisite

Name	Version
Python	3.8
pipenv(Python module)	2018.11.26 or up

Environment setup

0. Initialize environment variable

cp sample.env .env

1. Initialize Python environment

make init

2. Enter the environment and start developing

pipenv shell

3. Start related components of API service

make service_up

4. Start development API service

cd api/
uvicorn app:APP

The server will run at http://127.0.0.1:8000

5. (Optional)Stop related components of API service

make service_down

Formatting

This project uses black and isort for formatting

make reformat

Linting

This project uses pylint and flake8 for linting

make lint

Testing

This project uses pytest and its extension(pytest-cov) for testing

Deployment

Prerequisite

Name	Version
Docker	19.03.6
docker-compose	1.17.1

Building image

docker-compose build

This will build the image with tag fastapi-sqlalchemy:latest

Deployment step

The service is deployed with docker-compose.

0. Start containers

docker-compose up

Contribution

• Darkborderman/Divik([email protected])