Skip to content
Opinionated Flask services
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.globality
build.python-library/docker-base
microcosm_flask
.ackrc
.bumpversion.cfg
.dockerignore
.gitignore
Dockerfile.template
LICENSE
MANIFEST.in
README.md
entrypoint.sh
setup.cfg
setup.py
tox.ini

README.md

microcosm-flask

Opinionated Flask services.

Circle CI

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 and testing flags are propagated to the Flask application
You can’t perform that action at this time.