Pre-release
This release is a pre-release and may not be stable for production use.
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
debugandtestingflags are propagated to the Flask application
Release files for microcosm-flask 0.2696.dev2696
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| microcosm-flask-0.2696.dev2696.tar.gz | 47.5 kB | Details |
Release files / microcosm-flask-0.2696.dev2696.tar.gz
| Download URL | microcosm-flask-0.2696.dev2696.tar.gz |
|---|---|
| Size | 47.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0f536d0d1878cc7e491322c10a010e1898dac279b588798d9616e0b1a9c099c1
|
|
BLAKE2b-256 checksum How to use checksums |
8d2b81ac2ee726379a84bf27b75328ca6739d90b7ff0ade7447125f7612ac607
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.32.2 CPython/3.7.4
|