foprel / user-api

An experiment with user APIs in Python using the Flask library

Flask User API

⚠️ Security warning: This project is experimental and provided as-is (see MIT license).

Description

A simple Flask User API that leverages JSON Web Tokens for user authentication. SQLite is used for persistent storage of user information.

Installation

Input:

git clone https://github.com/foprel/flask-user-api.git
cd flask-user-api
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
flask run

Output:

 * Serving Flask app 'api' (lazy loading)
 * Environment: development
 * Debug mode: on
 * Running on http://127.0.0.1:5000 (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: ***-***-***

Todo

• Implement JWT authentication
• Implement user changes
• Standardize API responses

Docker

Follow these steps to run the application in docker:

docker build --tag flask-user-api .
docker run --publish 5000:5000 flask-user-api

Acknowledgements

• Flask
• JWT
• SQLite