Metadata-Version: 2.0
Name: Flask-RestPoints
Version: 0.0.7
Summary: Adds some common health check endpoints (ping, time, status)
Home-page: http://github.com/juztin/flask-restpoints
Author: Justin Wilson
Author-email: justin@minty.io
License: BSD
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Flask (>=0.9)

Flask-RestPoints
================

`Flask-RestPoints`_ is an extension to `Flask`_ that allows adds a few
health check endpoints (ping, epoch, and status) to the Flask application.

::

    from flask import Flask
    from flask_restpoints import RestPoints

    app = Flask(__name__)
    rest = RestPoints(app)

    @rest.status_job(name="PostgreSQL", timeout=5)
    def postgresql():
        # Perform a ping/query to Postgres

    @rest.status_job
    def facebook
        # Ping some Facebook service.


get Flask-RestPoints
====================

Install `flask`_

    sudo easy_install Flask-RestPoints

Download the latest release from `Python Package Index`_
or clone `the repository`_

.. _Flask-RestPoints: http://packages.python.org/Flask-RestPoints
.. _Flask: http://flask.pocoo.org/
.. _the repository: https://github.com/juztin/flask-restpoints
.. _Python Package Index: https://pypi.python.org/pypi/Flask-RestPoints


