Skip to main content
https://raw.githubusercontent.com/numberly/flask-stupe/master/artwork/stupeflask.png

https://img.shields.io/pypi/v/flask-stupe.svg https://img.shields.io/github/license/numberly/flask-stupe.svg https://img.shields.io/travis/numberly/flask-stupe.svg https://img.shields.io/coveralls/numberly/flask-stupe.svg https://readthedocs.org/projects/flask-stupe/badge

a.k.a. « Flask on steroids »

An opinionated Flask extension designed by and for web developers to reduce boilerplate code when working with Marshmallow, MongoDB and/or JSON.

Documentation: https://flask-stupe.readthedocs.io

Features

  • Return any object type in views, and it will be coerced to a flask.Response

  • Validate payloads through Marshmallow schemas

  • Easily add JSON converters for any custom type

  • Fetch all the blueprints from a whole module in one line

  • Native ObjectId support for both Flask and Marshmallow

  • Powerful configuration management

  • Decorators to handle authentication, permissions, and pagination

  • 100% coverage and no dependency

Install

$ pip install flask-stupe

Comparison

Here is a comparison of a bare Flask application and its equivalent Stupeflask version. They both rely on MongoDB, handle input and output in JSON, and allow to create a user and retrieve one or more.

Bare Flask

With Stupeflask

from bson import ObjectId
from flask import abort, Flask, jsonify, request
from marshmallow import Schema
from marshmallow.fields import String
from pymongo import MongoClient

app = Flask(__name__)
users = MongoClient().database.users


class UserSchema(Schema):
    username = String(required=True)
    password = String()


@app.route("/user", methods=["POST"])
def post_user():
    json = request.get_json(force=True)
    validation_result = UserSchema().load(json)
    if validation_result.errors:
        abort(400, validation_result.errors)
    result = users.insert_one(validation_result.data)
    inserted_id = str(result.inserted_id)
    validation_result.data.update(_id=inserted_id)
    return jsonify(validation_result.data)


@app.route("/user/<id>")
def get_user(id):
    try:
        id = ObjectId(id)
    except ValueError:
        abort(404)
    user = users.find_one({"_id": id})
    user["_id"] = str(user["_id"])
    return jsonify(user)


@app.route("/users")
def get_users():
    limit = request.args.get("limit", 100, type=int)
    skip = request.args.get("skip", 0, type=int)
    cursor = users.find().limit(limit).skip(skip)
    return jsonify(list(cursor))
from flask import request
from flask_stupe import paginate, schema_required
from flask_stupe.json import Stupeflask
from marshmallow import Schema
from marshmallow.fields import String
from pymongo import MongoClient

app = Stupeflask(__name__)
users = MongoClient().database.users


class UserSchema(Schema):
    username = String(required=True)
    password = String()


@app.route("/user", methods=["POST"])
@schema_required(UserSchema())
def post_user():
    result = users.insert_one(request.schema)
    request.schema.update(_id=result.inserted_id)
    return request.schema


@app.route("/user/<ObjectId:id>")
def get_user(id):
    return users.find_one({"_id": id})


@app.route("/users")
@paginate(limit=100)
def get_users():
    return users.find()

Tests

To run Flask-Stupe tests:

  • install developers requirements with pip install -r requirements.txt;

  • run pytest.

License

MIT

Metadata

Release files for Flask-Stupe 4.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Flask-Stupe 4.4.0
File Size Uploaded
Flask-Stupe-4.4.0.tar.gz 11.9 kB Details

Release files / Flask-Stupe-4.4.0.tar.gz

Download URL Flask-Stupe-4.4.0.tar.gz
Size 11.9 kB
Tags Source
SHA-256 checksum
How to use checksums
8f0bca4405d4ff105baeb1f7b7ea48765100918d6aaf2e5ff131b1e765db611b
BLAKE2b-256 checksum
How to use checksums
144a0142d6fdce926e0a1d41b0a20ef3045c8cf3c81a858577e7cc40fe7acfe4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.5

Release history Release notifications | RSS feed

This release

4.4.0 This release

1 release file

4.3.0

2 release files

4.2.0

2 release files

4.1.2

2 release files

4.0.0

1 release file

3.8.0

2 release files

3.7.1

1 release file

3.7.0

1 release file

3.6.4

2 release files

3.6.3

2 release files

3.6.2

1 release file

3.6.1

1 release file

3.6.0

2 release files

3.5.2

2 release files

3.5.1

2 release files

3.5.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page