Flaskteroids

Flaskteroids: A complete, batteries-included Python MVC framework.

Flaskteroids (or Flask on Steroids) is a lightweight yet powerful Python MVC framework designed to provide the closest possible experience to developing web applications in Ruby on Rails, in the Python world. Flaskteroids uses Rails 8 as its reference implementation for conventions, framework boundaries, and developer experience while expressing those conventions through Python and Flask.

Our mission is to bring exceptional productivity and developer happiness to the Python ecosystem through a batteries-included framework that emphasizes convention over configuration. This means you can focus on building great applications rather than boilerplate code, while maintaining the full power of Flask and its rich ecosystem.

Flaskteroids stays lean, fast, and secure by carefully selecting core dependencies and providing everything you need out of the box — from database management to background jobs — without unnecessary complexity.

Features

• Full MVC Architecture: Clean separation of concerns with Models, Views, and Controllers.
• Elegant Routing: Intuitive and resourceful routing that automatically generates RESTful routes for your resources.
• Built-in ORM: Seamless integration with SQLAlchemy and Alembic for database management and migrations.
• Background Jobs: Integrated with Celery for easy background job processing.
• RESTful by Design: Quickly build API routes with automatic JSON responses for data-oriented actions.
• Powerful CLI: A rich set of commands for generating models, controllers, mailers, scaffolds, and more.
• Flask Compatibility: Retains the full power of Flask and its rich ecosystem while adding an integrated application framework.
• Convention Over Configuration: Sensible defaults and automatic discovery reduce boilerplate code.
• Application Configuration: Environment settings, database.yml, encrypted credentials, and initializers are integrated by default.
• Rails-style Testing: Transactional tests, YAML fixtures, generated tests, job and mail assertions, and browser system tests powered by pytest.

Installation

To get started, install the Flaskteroids package using pip:

pip install flaskteroids

Getting Started

1. Creating a New App

Create a new Flaskteroids application using the flaskteroids new command:

flaskteroids new my_app
cd my_app

This creates a new directory called my_app with a standard application structure.

2. Running the Server

To start the development server, run:

flask run

Now, open your browser and navigate to http://127.0.0.1:5000. You should see the Flaskteroids welcome page!

Your First Feature: A Blog

Let's create a simple blog to see the power of scaffolding. Inside your my_app follow the next steps:

1. Generate a Post scaffold: This command will create the model, controller, views, and database migration for a Post resource with title and content fields.

   flask generate scaffold Post title:string content:text
   

2. Run the database migration: Apply the changes to your database schema.

   flask db:migrate
   

3. Start the server:

   flask run
   

Now, visit http://127.0.0.1:5000/posts in your browser. You have a complete set of pages to create, view, update, and delete posts.

For more check out the documentation

Releasing

Maintainers: see the release guide for the automated release PR and PyPI publishing process.

License

Flaskteroids is open-source and released under the MIT License.