Flask(-Twisted) microframework for microservices with Prometheus and Sentry support.
Project description
# flacon
[![Build Status](https://travis-ci.org/iksaif/flacon.svg?branch=master)](https://travis-ci.org/iksaif/flacon)
[![Coverage Status](https://coveralls.io/repos/github/iksaif/flacon/badge.svg)](https://coveralls.io/github/iksaif/flacon?branch=master)
[![PyPI version](https://badge.fury.io/py/flacon.svg)](https://badge.fury.io/py/flacon)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/flacon.svg)](https://pypi-hypernode.com/pypi/flacon/)
Flask(-Twisted/Gunicorn) microframework for microservices with Prometheus and Sentry support.
The goal is to remove most of the boilerplate necessary to start a simple HTTP application.
This provides:
* Sane arguments (`--host`, `--port`, `--debug`, `--log-level`)
* Support to have a production ready uwsgi container (`--twisted` or `--gunicorn`)
* Prometheus support with default metrics (`flacon.metrics`: See [prometheus_flask_exporter](https://github.com/rycus86/prometheus_flask_exporter))
* Optional sentry support if the `SENTRY_DSN` env var is set.
* If you have a 'static' directory in your module, just put a favicon.ico inside!
## Installation
```bash
pip install flacon
# To use a production ready wsgi server install one of the following extra requirements
pip install flacon[twisted]
pip install flacon[gunicorn]
```
## Quick-start
```python
from flacon import Flacon
flacon = Flacon(__name__)
app = flacon.app # This is a flask.Flask() app.
@app.route('/example')
def index():
return 'Example'
def main():
flacon.run()
if __name__ == '__main__':
main()
```
Want to know more? Look at [example/app.py](example/app.py), you can run it with `flacon-example`.
[![Build Status](https://travis-ci.org/iksaif/flacon.svg?branch=master)](https://travis-ci.org/iksaif/flacon)
[![Coverage Status](https://coveralls.io/repos/github/iksaif/flacon/badge.svg)](https://coveralls.io/github/iksaif/flacon?branch=master)
[![PyPI version](https://badge.fury.io/py/flacon.svg)](https://badge.fury.io/py/flacon)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/flacon.svg)](https://pypi-hypernode.com/pypi/flacon/)
Flask(-Twisted/Gunicorn) microframework for microservices with Prometheus and Sentry support.
The goal is to remove most of the boilerplate necessary to start a simple HTTP application.
This provides:
* Sane arguments (`--host`, `--port`, `--debug`, `--log-level`)
* Support to have a production ready uwsgi container (`--twisted` or `--gunicorn`)
* Prometheus support with default metrics (`flacon.metrics`: See [prometheus_flask_exporter](https://github.com/rycus86/prometheus_flask_exporter))
* Optional sentry support if the `SENTRY_DSN` env var is set.
* If you have a 'static' directory in your module, just put a favicon.ico inside!
## Installation
```bash
pip install flacon
# To use a production ready wsgi server install one of the following extra requirements
pip install flacon[twisted]
pip install flacon[gunicorn]
```
## Quick-start
```python
from flacon import Flacon
flacon = Flacon(__name__)
app = flacon.app # This is a flask.Flask() app.
@app.route('/example')
def index():
return 'Example'
def main():
flacon.run()
if __name__ == '__main__':
main()
```
Want to know more? Look at [example/app.py](example/app.py), you can run it with `flacon-example`.
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
flacon-0.3.0.tar.gz
(10.2 kB
view details)
File details
Details for the file flacon-0.3.0.tar.gz
.
File metadata
- Download URL: flacon-0.3.0.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87b2ed5dc5f46c925de2187c8724af00693dffaa796a0b25aca02a91aa437d77 |
|
MD5 | c24e530186037f608ffd7dc7b791a48f |
|
BLAKE2b-256 | 030c2ffdc223cd117513f1ef67fd36a4ee81689d19efdfc834ebfc3184b993f4 |