Flask-Full: Your Go-To Boilerplate for Flask Applications

Building a robust API backend can often feel overwhelming, especially when you're trying to integrate various tools and frameworks. If you've been in the situation where you need a solid structure to kickstart your Flask project, you're not alone. Flask-Full offers a comprehensive boilerplate that simplifies the setup process while providing essential features for scalability and performance.

What Is Flask-Full?

Flask-Full is a boilerplate framework built on top of Flask, designed specifically for developing large API backend applications. It comes equipped with built-in support for shell commands, Celery for asynchronous task management, WebSockets with Eventlet, and MongoEngine as the ORM. The project also features automatic API documentation via Swagger UI and Sphinx, making it easy to generate and maintain documentation.

Key Features

• Celery Integration: Utilize the power of Celery for background task processing, allowing you to offload time-consuming tasks from your main application thread.
• MongoEngine ORM: Simplifies database interactions with MongoDB, enabling you to work with Python objects instead of raw database queries.
• WebSocket Support: Real-time communication is made easy with Eventlet, allowing your app to handle multiple concurrent connections efficiently.
• Automatic API Documentation: Swagger UI provides a user-friendly interface for exploring your API, while Sphinx helps generate comprehensive documentation.
• Shell Commands: Create custom shell commands to manage your application more effectively, streamlining your development workflow.
• Signal Handling: Leverage Flask’s signal system to implement event-driven programming, making your application more responsive to various events.
• Structured Directory Layout: The boilerplate comes with a clear and organized directory structure, making it easy to navigate and maintain your codebase.
• Cross-Platform Compatibility: Flask-Full works seamlessly on MacOS, Linux, and Windows, ensuring you can develop in your preferred environment.

Installation & Setup

Getting started with Flask-Full is straightforward. Follow these simple steps to set up your environment:

git clone https://github.com/gofynd/flask-full.git
cd flask-full  # Rename repository directory if needed
pip3 install -r requirements.txt

To start the server, use the following command:

python3 manage.py run -p 8080

Your server will be accessible at http://localhost:8080/ping/, which should return {"message": "pong"}.

For API documentation, visit http://localhost:8080/apidocs/.

To start Celery and Beat, run:

python3 manage.py celery
python3 manage.py beat

And to see all available commands, simply run:

python3 manage.py

How to Use It

Let’s consider a practical example. Imagine you want to implement a task that fetches data from an external API and stores it in your MongoDB database. With Flask-Full, you can create a custom Celery task as follows:

from celery import Celery
from your_app import app

celery = Celery(app.name, broker='redis://localhost:6379/0')

@celery.task
def fetch_and_store_data(api_url):
    response = requests.get(api_url)
    data = response.json()
    # Logic to store data in MongoDB

This task can be called asynchronously, allowing your API to remain responsive while the data-fetching operation runs in the background.

Who Should Use Flask-Full?

Flask-Full is perfect for developers looking to create scalable and maintainable Flask applications quickly. If you're building an API backend for a web or mobile application, or if you need to integrate real-time features, this boilerplate will save you significant setup time. It's also a great learning resource for those who want to understand how to structure larger Flask applications effectively.

Final Thoughts

In my opinion, Flask-Full is a fantastic starting point for any developer aiming to build robust API backends. Its integration of essential tools like Celery and MongoDB, along with the ease of use provided by Swagger and Sphinx documentation, makes it a well-rounded choice for both beginners and experienced developers. Whether you’re starting a new project or looking to maintain an existing one, Flask-Full provides the structure and features you need to succeed.