Flaskteroids

A Rails-inspired Python MVC framework built on Flask, SQLAlchemy, and Celery.

Flaskteroids brings Rails conventions to Python. It uses Rails 8 as the reference for application structure and framework behavior, with Flask handling HTTP requests, SQLAlchemy and Alembic handling the database, and Celery running background jobs.

Models, controllers, and templates live in conventional directories. The framework discovers them without manual registration. Flask APIs and extensions remain available when you need them.

What's included

• Resource routing with CRUD routes and path helpers.
• Active Record-style models with associations, validations, and lifecycle callbacks.
• Jinja templates, form helpers, and HTML or JSON responses.
• Generators for models, migrations, controllers, scaffolds, mailers, and authentication.
• Background jobs and email delivery.
• Environment settings, database.yml, encrypted credentials, and boot-time initializers.
• Pytest-based transactional tests, YAML fixtures, job and mail assertions, and Playwright browser tests.

Installation

Requires Python 3.12 or newer. Install Flaskteroids in your Python environment:

pip install flaskteroids

Getting started

Create an application. Git must be installed.

flaskteroids new my_app
cd my_app

The command creates the application files and initializes a Git repository in my_app. Start the development server:

flask run

Open http://127.0.0.1:5000 to see the welcome page.

Add a posts resource

Stop the server and run these commands inside my_app:

flask generate scaffold Post title:string content:text
flask db:migrate
flask run

The scaffold generates a model, migration, controller, views, and routes. Visit http://127.0.0.1:5000/posts/ to create, view, edit, and delete posts.

See the documentation for configuration, testing, and the API guides.

Agent skills

Flaskteroids bundles coding guidance for agents with each release. New applications include .agents/skills/using-flaskteroids/SKILL.md, which points agents to instructions for the installed framework version. These instructions require agents to use public Flaskteroids APIs when they cover the task, rather than calling dependency internals.

In your application's Python environment, locate the installed skills with:

flaskteroids agent-skills path

The command prints the absolute skills directory path. Read using-flaskteroids/SKILL.md inside that directory for version-matched guidance. No application configuration or initialization is required.

Releasing

See the release guide for release PRs and PyPI publishing.

License

Flaskteroids is released under the MIT License.