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
pytest
Linting
Lint the code:
NAME=microcosm_flask ./entrypoint.sh lint
NAME=microcosm_flask ./entrypoint.sh typehinting
Configuration
- The object graph's
debugandtestingflags are propagated to the Flask application
1 maintainer
Metadata
1 maintainer
Release files for microcosm-flask 6.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| microcosm_flask-6.1.0-py3-none-any.whl | Python 3 | none | any | Details for microcosm_flask-6.1.0-py3-none-any.whl |
Release files / microcosm_flask-6.1.0-py3-none-any.whl
| Download URL | microcosm_flask-6.1.0-py3-none-any.whl |
|---|---|
| Size | 86.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5a21090b27ed19b0bc2e3291efb89ce528e42b58a942f7a435101b1c0aebeb23
|
|
BLAKE2b-256 checksum How to use checksums |
691e725f512b6d9b84573ebbf2ba9d92169c9cca072383a286dfbfa89f527a10
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.9
|
Security for microcosm-flask 6.1.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.
