Skip to main content

a.k.a. « Flask on steroids »

Project description

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

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.

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

  • Powerful configuration management

  • Decorators to handle authentication and permissions

  • 100% coverage and no dependency

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 or retrieve an user.

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)
from flask import request
from flask_stupe import 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})

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Stupe-3.5.1.tar.gz (3.2 kB view hashes)

Uploaded Source

Built Distribution

Flask_Stupe-3.5.1-py2.py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page