https://github.com/markdouthwaite/minimal-flask-api
A template for 'production ready' Flask APIs with Flask & Gunicorn. Includes template test and error-handling files.
https://github.com/markdouthwaite/minimal-flask-api
flask gunicorn locust pytest python python-api
Last synced: 5 months ago
JSON representation
A template for 'production ready' Flask APIs with Flask & Gunicorn. Includes template test and error-handling files.
- Host: GitHub
- URL: https://github.com/markdouthwaite/minimal-flask-api
- Owner: markdouthwaite
- License: mit
- Created: 2021-01-16T17:04:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-02T14:40:44.000Z (about 3 years ago)
- Last Synced: 2023-03-05T12:50:20.838Z (about 2 years ago)
- Topics: flask, gunicorn, locust, pytest, python, python-api
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 78
- Watchers: 3
- Forks: 35
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# minimal-flask-api
This [template repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
provides a minimal configuration for a 'production-ready' Flask API
project. It includes a basic project structure and 'seed' files for functional and
non-function testing, a basic application structure (including error-handling
blueprint), and a few assorted 'getting started' files too.
The template has been set up for use with Python >= 3.7 and [Docker](https://www.docker.com/).
## Running locally
To run the basic server, you'll need to install a few requirements. To do this, run:
```bash
pip install -r requirements/common.txt
```
This will install only the dependencies required to run the server. To boot up the
default server, you can run:
```bash
bash bin/run.sh
```
This will start a [Gunicorn](https://gunicorn.org/) server that wraps the Flask app
defined in `src/app.py`. Note that [this is one of the recommended ways of deploying a
Flask app 'in production'](https://flask.palletsprojects.com/en/1.1.x/deploying/wsgi-standalone/).
The server shipped with Flask is [intended for development
purposes only](https://flask.palletsprojects.com/en/1.1.x/deploying/#deployment).
You should now be able to send:
```bash
curl localhost:5000/health
```
And receive the response `OK` and status code `200`.
## Running with `docker`
Unsurprisingly, you'll need [Docker](https://www.docker.com/products/docker-desktop)
installed to run this project with Docker. To build a containerised version of the API,
run:
```bash
docker build . -t flask-app
```
To launch the containerised app, run:
```bash
docker run -p 5000:5000 flask-app
```
You should see your server boot up, and should be accessible as before.
## Developing with the template
To develop the template for your own project, you'll need to make sure to [create your
own repository from this template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
and then install the project's development dependencies. You can do this with:
```bash
pip install -r requirements/develop.txt
```
This'll install some style formatting and testing tools (including `pytest` and
`locust`).