Opinionated persistence with FlaskQL
Project description
microcosm-flask
Opinionated Flask services.
Conventions
- Classify API endpoints according to an enumerated set of operations with well-defined naming conventions
- Handle errors consistently using a top-level error and nested sub-errrors
- Handle UUIDs as route path keys
- Protect endpoints with basic auth
- Use HAL JSON links to related resources to each other
- Use Swagger to publish endpoints for interoperability
- Automate generation of endpoints according to conventions:
- A health check API endpoint exposes service health
- RESTful endpoints provide CRUD operations on resources
- RESTful endpoints allows one resource to be related to another
- API discovery endpoints allow resource data to be discovered/spidered
- Swagger endpoints allow endpoint integration to be automated
Setup
Create a virtualenv
mkvirtualenv microcosm-flask
Install dependencies
pip install -U -e .
Tests
Run the tests
python setup.py nosetests
Configuration
- The object graph's
debug
andtesting
flags are propagated to the Flask application
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for microcosm-flask-0.2696.dev2696.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f536d0d1878cc7e491322c10a010e1898dac279b588798d9616e0b1a9c099c1 |
|
MD5 | e1063ed0ccd931dd5d80e2ca0b5d462c |
|
BLAKE2b-256 | 8d2b81ac2ee726379a84bf27b75328ca6739d90b7ff0ade7447125f7612ac607 |