Skip to main content

Powerful REST API framework for Flask and SQLAlchemy

Project description

https://img.shields.io/travis/biosustain/potion/master.svg?style=flat-square https://img.shields.io/coveralls/biosustain/potion/master.svg?style=flat-square https://img.shields.io/pypi/v/Flask-Potion.svg?style=flat-square https://img.shields.io/pypi/l/Flask-Potion.svg?style=flat-square

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 models, but it is also possible to integrate other data stores, or even to use parts of Potion without any data store at all.

User’s Guide

The user’s guide and documentation is published here:

http://potion.readthedocs.org/

Features

  • Powerful API framework both for data-store-linked and plain resources
  • JSON-based and fully self-documenting with JSON Hyper-Schema
  • Flask-SQLAlchemy integration
  • Filtering, sorting, pagination, validation, built right in
  • Smart system for handling relations between resources
  • 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
  • Natural keys for extra simple relation querying (planned)

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.

Authors

Potion is written and maintained by Lars Schöning.

Thanks to our contributors.

Project details


Download files

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

Files for Flask-Potion, version 0.4.1
Filename, size File type Python version Upload date Hashes
Filename, size Flask-Potion-0.4.1.tar.gz (28.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page