https://github.com/criteo/gourde

Flask sugar for Python microservices
https://github.com/criteo/gourde

flask logs metrics sugar twisted

Last synced: 11 months ago
JSON representation

Flask sugar for Python microservices

• Host: GitHub
• URL: https://github.com/criteo/gourde
• Owner: criteo
• License: apache-2.0
• Created: 2018-03-29T07:37:00.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2023-09-14T08:34:48.000Z (over 2 years ago)
• Last Synced: 2024-11-16T03:17:00.025Z (over 1 year ago)
• Topics: flask, logs, metrics, sugar, twisted
• Language: Python
• Homepage:
• Size: 63.5 KB
• Stars: 7
• Watchers: 37
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gourde

![Build Status](https://github.com/github/docs/actions/workflows/python-package.yml/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/criteo/gourde/badge.svg)](https://coveralls.io/github/criteo/gourde?branch=main)

[![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.python.org/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`.