This repository contains a Flask API project primarily intended for study and learning purposes. As I continue to learn and grow in my understanding of Flask and web development, I'll be updating this project to reflect new knowledge, best practices, and improvements.
This Flask API provides basic CRUD operations for user management. It's designed to demonstrate fundamental concepts of Flask, RESTful API design, and Python development.
- Basic CRUD operations for users.
- In-memory database for demonstration purposes.
- Error handling and validation.
- Docker integration for containerization.
- Python 3+
- Docker (optional for containerization)
- Clone the repository:
git clone https://github.com/CleytonBonamigo/simple-python-api.git
cd simple-python-api- Install the required packages:
cd examples/flask/in-memory # Or whatever example you want to run
pip install -r requirements.txt- Run the application:
python main.py --port=1234 # Port is optionalExplore various examples in the examples directory:
- Basic - Post explaining
- Basic CRUD operations for users.
- In-memory database for demonstration purposes.
- Error handling and validation.
- Docker integration for containerization.
If you prefer to run the application inside a Docker container, where will install everything for you:
docker-compose up -dWhile this project is primarily for personal study, contributions or suggestions are welcome. Feel free to open an issue or submit a pull request.
This project is open-source and available under the MIT License.
As I continue my journey in web development and Flask, I plan to update this project with:
- Test coverage.
- Database integration.
- User authentication and authorization.
- Enhanced logging and monitoring. And more...