Flask-Potion
Description
Flask-Potion is a powerful Flask extension for building RESTful JSON APIs. Potion features include validation, model resources and routes, relations, object permissions, filtering, sorting, pagination, signals, and automatic API schema generation.
Potion is designed to handle SQLAlchemy, peewee and MongoEngine models. It is possible to add backends for other data stores, or even to use a subset of Potion without any data store at all.
User’s Guide
The user’s guide and documentation is published here:
Versioning
Potion will use semantic versioning from v1.0.0. Until then, the minor version is used for changes known to be breaking.
Features
Powerful API framework both for data-store-linked and plain resources
JSON-based and fully self-documenting with JSON Hyper-Schema
Backend integrations:
Flask-SQLAlchemy
Peewee (contributed by Michael Lavers)
Flask-MongoEngine
Filtering, sorting, pagination, validation, built right in
Smart system for handling relations between resources
Natural keys for extra simple relation querying
Easy-to-use, yet highly flexible, optional permissions system
Signals for pre- and post-processing of requests
Very customizable — everything is just a resource, route, or schema
Example (SQLAlchemy)
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_potion import Api, ModelResource, fields
from flask_potion.routes import ItemRoute
app = Flask(__name__)
db = SQLAlchemy(app)
api = Api(app)
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(), nullable=False)
db.create_all()
class UserResource(ModelResource):
class Meta:
model = User
@ItemRoute.GET
def greeting(self, user) -> fields.String():
return "Hello, {}!".format(user.name)
api.add_resource(UserResource)
if __name__ == '__main__':
app.run()Long-term goals
The web nowadays is increasingly push rather than pull, so Potion is gradually building up to providing a scalable WebSocket service (using asyncio and a message queue). This service will mirror the RESTful API so that every GET request can be done “live”. (In the meantime, you can use the signals module to roll your own solution).
Potion is written in a way that makes it very easy to cache resources. A natural goal is to eventually ship Potion with a built-in server-side caching solution.
1 maintainer
Metadata
1 maintainer
Release files for Flask-Potion 0.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| Flask-Potion-0.10.0.tar.gz | 35.1 kB | Without provenance | Details |
Release files / Flask-Potion-0.10.0.tar.gz
| Download URL | Flask-Potion-0.10.0.tar.gz |
|---|---|
| Size | 35.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2c972de20bdc2921a93fe29ab78af3d12d866d3d166a52aa8536d9b6b00a5a3d
|
|
BLAKE2b-256 checksum How to use checksums |
045b20a20344e29a9f8f805b8914e9b963edba466e8452571380a9b7b57741d6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for Flask-Potion 0.10.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
