selfmadeselfpaidx / flask-backend-api-template

Template to turn locally running backend Python code into an API for Web Apps

🚀 Flask Backend API Project Template

When you have a Python project that runs locally but want to turn it into a webapp, you have to make it into an API. This is a template that takes care of this for you.

Put your backend code in /api, and add endpoints to call it in routes.py.

Put your frontend code in /frontend and call the flask endpoint, and voila - all done!

There might be some rough edges around this template, but it should give you an idea of what to do.

Project Template: Backend API

🛠️ Directory Structure

   api                      # API related code
    ├── Dockerfile           # Dockerfile for the API
    ├── README.md            # README for the API
    ├── __init__.py          # API package initialization
    ├── app                  # Main application package
    │   ├── __init__.py      # App package initialization
    │   ├── config.py        # Configuration file
    │   ├── data
    │   │   └── database_service.py # Database service
    │   ├── health
    │   │   ├── __init__.py
    │   │   └── health_service.py # Health check service
    │   ├── routes.py        # Route definitions
    │   └── utils            # Utility functions and classes
    ├── main.py              # Main entry for running the API
    ├── requirements.txt     # Required Python packages
    ├── swagger.json         # Swagger specification
    └── tests                # Test package
        ├── __init__.py      # Test package initialization
        ├── conftest.py      # Pytest configuration
        └── test_routes.py   # Tests for the routes

🧭 How To Run (Local)

1. cd api

2. pip install -r requirements.txt

3. python app.py

4. Trigger endpoints with:

   curl -X 'GET' \
   'http://127.0.0.1:8000/health' \
   -H 'accept: application/json'

5. Run tests with: curl -X 'GET'
   'http://127.0.0.1:8000/health'
   -H 'accept: application/json'

   python -m pytest -p no:warnings

CI/CD + Dev Notes

Python Version and Code Style

• Using Python 3.7 for development.
• Code formatting is handled by black, a code formatter that enforces PEP 8 style guide.
• Linting is done with flake8, which helps to identify coding errors and maintain code quality.

Pre-commit Hooks

• The project uses pre-commit to manage and maintain pre-commit hooks.
• Run pre-commit install to install pre-commit formatting and linting. This ensures that every commit adheres to the code style guide and passes linting checks.
• You can manually run all pre-commit hooks on a repository with pre-commit run --all-files.