Flask(-Twisted) microframework for microservices with Prometheus and Sentry support.
Project description
# gourde
[![Build Status](https://travis-ci.org/criteo/gourde.svg?branch=master)](https://travis-ci.org/criteo/gourde)
[![Coverage Status](https://coveralls.io/repos/github/criteo/gourde/badge.svg)](https://coveralls.io/github/criteo/gourde?branch=master)
[![PyPI version](https://badge.fury.io/py/gourde.svg)](https://badge.fury.io/py/gourde)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/gourde.svg)](https://pypi-hypernode.com/pypi/gourde/)
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 (`gourde.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 gourde
# To use a production ready wsgi server install one of the following extra requirements
pip install gourde[twisted]
pip install gourde[gunicorn]
```
## Quick-start
```python
from gourde import Gourde
gourde = Gourde(__name__)
app = gourde.app # This is a flask.Flask() app.
@app.route('/example')
def index():
return 'Example'
def main():
gourde.run()
if __name__ == '__main__':
main()
```
Want to know more? Look at [example/app.py](example/app.py), you can run it with `gourde-example`.
[![Build Status](https://travis-ci.org/criteo/gourde.svg?branch=master)](https://travis-ci.org/criteo/gourde)
[![Coverage Status](https://coveralls.io/repos/github/criteo/gourde/badge.svg)](https://coveralls.io/github/criteo/gourde?branch=master)
[![PyPI version](https://badge.fury.io/py/gourde.svg)](https://badge.fury.io/py/gourde)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/gourde.svg)](https://pypi-hypernode.com/pypi/gourde/)
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 (`gourde.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 gourde
# To use a production ready wsgi server install one of the following extra requirements
pip install gourde[twisted]
pip install gourde[gunicorn]
```
## Quick-start
```python
from gourde import Gourde
gourde = Gourde(__name__)
app = gourde.app # This is a flask.Flask() app.
@app.route('/example')
def index():
return 'Example'
def main():
gourde.run()
if __name__ == '__main__':
main()
```
Want to know more? Look at [example/app.py](example/app.py), you can run it with `gourde-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
gourde-0.3.0.tar.gz
(9.2 kB
view details)
File details
Details for the file gourde-0.3.0.tar.gz
.
File metadata
- Download URL: gourde-0.3.0.tar.gz
- Upload date:
- Size: 9.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42d100aea3af35870c368673d2c6ce21796774a8fb44a92de777f4586cb29bf8 |
|
MD5 | 58b8899ccf96aaf0a8f2b33f0493140a |
|
BLAKE2b-256 | 4ead7a42a6dfea4db4e96979b26542e215f11e36d563bc8ec36a9061bee2ac80 |