Basic python api project using flask
Disclaimer: this project is only intended as a basic sample application. In a production environment, it is not recommended to directly load a Flask application in this way. For more information, see this page in Flask's official documentation.
This project was set up on an Arch linux-based distro, using a python virtual environment for local development. To run this project, you will need either Docker/Podman, or python, pip, and venv (recommended) installed locally.
Running this application requires you to have python/pip set up locally.
Step 1: Install dependencies
pip install -r requirements.txt
Step 2: Run the app python -m flask run --host=0.0.0.0
Running over docker requires you to have docker installed and the docker engine running
Step 1: Build the image
docker build -t python-api-template .
Step 2: Run the image
docker run -p 5000:5000 python-api-template
When the app is running, it should be accessible over the local network. You can either open the address localhost:5000/ in your browser, or enter the following command in a terminal:
curl http://localhost:5000/