Skip to content

This template provides a quick Flask API with some pre-defined linting and formatting packages.

License

Notifications You must be signed in to change notification settings

amirsalaar/flask-api-boilerplate

Repository files navigation

Documentation

This is an open-source Flask API template to get developers speed up their development process. To contribute to the project, simply fork it and make your changes and submit a pull request.

Dependencies and Setup

Following dependencies are used to run the project:

Dependency Name Description
poetry Dependency and package management.
pytest We are using pytest as our unit testing framework.
Flask This boilerplate provides a Flask production-ready API template, so we use Flask as our main framework.
black black is used for styling and formatting our Python code.
isort isort is used for organizing/optimizing imports within your python modules.
mypy mypy is a static type checker that is used to check the typings.
flake8 This is used as our linting style.
pre-commit We use pre-commit to manage our git hooks. There are few hooks that is installed by default in this repo
for pre-commit and they are mentioned in .pre-commit-config.yaml
python-dotenv This is used to load .env files into our environment.
waitress We use this library to create a production-ready server.

About

This template provides a quick Flask API with some pre-defined linting and formatting packages.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published