A RESTful API service template built with fastapi.
Development
Prerequisite
| Name | Version |
|---|---|
| Python | 3.8 |
| pipenv(Python module) | 2018.11.26 or up |
Environment setup
- Initialize environment variable
- Initialize Python environment
- Enter the environment and start developing
- Start development API service
The server will run at http://127.0.0.1:8000
Formatting
This project uses black and isort for formatting
Linting
This project uses pylint and flake8 for linting
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
This will build the image with tag fastapi:latest
Deployment step
The service is deployed with docker-compose
- Start containers
Contribution
- Darkborderman/Divik(reastw1234@gmail.com)