https://github.com/amirsalaar/flask-api-boilerplate
This template provides a quick Flask API with some pre-defined linting and formatting packages.
https://github.com/amirsalaar/flask-api-boilerplate
boilerplate flask python template
Last synced: 30 days ago
JSON representation
This template provides a quick Flask API with some pre-defined linting and formatting packages.
- Host: GitHub
- URL: https://github.com/amirsalaar/flask-api-boilerplate
- Owner: amirsalaar
- License: mit
- Created: 2021-10-29T22:30:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-01T19:59:53.000Z (over 3 years ago)
- Last Synced: 2024-05-01T14:54:37.865Z (about 2 years ago)
- Topics: boilerplate, flask, python, template
- Language: Dockerfile
- Homepage:
- Size: 278 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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. |