Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

gourde

Build Status Coverage Status PyPI version Supported Python versions

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)
  • 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

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

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, you can run it with gourde-example.