A small handler for reporting application status
Go to file
Gavin M. Roy 99d0eababe Merge pull request #2 from sprockets/fix-readme
Read the readme instead of the test requirements
2015-06-09 11:18:56 -04:00
docs Bump to 0.1.2 2015-06-08 11:32:15 -04:00
sprockets Bump to 0.1.2 2015-06-08 11:32:15 -04:00
.editorconfig Initial commit 2015-06-01 13:52:32 -04:00
.gitignore Initial commit 2015-06-01 13:52:32 -04:00
.travis.yml Initial commit 2015-06-01 13:52:32 -04:00
LICENSE Initial commit 2015-06-01 13:52:32 -04:00
MANIFEST.in Initial commit 2015-06-01 13:52:32 -04:00
README.rst Add the README 2015-06-01 13:51:37 -04:00
requirements.txt Add the tornado dependency, dont pin 2015-06-08 10:13:38 -04:00
setup.cfg Initial commit 2015-06-01 13:52:32 -04:00
setup.py Read the readme instead of the test requirements 2015-06-09 10:55:59 -04:00
test-requirements.txt Update tests to reflect new tornado dependency 2015-06-08 10:27:46 -04:00
tests.py Update tests to reflect new tornado dependency 2015-06-08 10:27:46 -04:00

README.rst

sprockets.handlers.status
=========================
A small handler for reporting application status

|Version| |Downloads| |Status| |Coverage| |License|

Installation
------------
``sprockets.handlers.status`` is available on the
`Python Package Index <https://pypi.python.org/pypi/sprockets.handlers.status>`_
and can be installed via ``pip`` or ``easy_install``:

.. code:: bash

  pip install sprockets.handlers.status

Documentation
-------------
https://sprocketshandlersstatus.readthedocs.org

Example
-------
The following example demonstrates how to initialize the status handler for the
base application status page.

.. code:: python

    import tornado.ioloop
    import tornado.web
    from sprockets.handlers import status


    application = tornado.web.Application([
        ('/status', status.StatusHandler),
    ])

    if __name__ == '__main__':

        # Set the application name to the local package
        status.set_application('mypackage')

        application.listen(8888)
        tornado.ioloop.IOLoop.current().start()

Version History
---------------
Available at https://sprocketshandlersstatus.readthedocs.org/en/latest/history.html

.. |Version| image:: https://img.shields.io/pypi/v/sprockets.handlers.status.svg?
   :target: http://badge.fury.io/py/sprockets.handlers.status

.. |Status| image:: https://img.shields.io/travis/sprockets/sprockets.handlers.status.svg?
   :target: https://travis-ci.org/sprockets/sprockets.handlers.status

.. |Coverage| image:: https://img.shields.io/codecov/c/github/sprockets/sprockets.handlers.status.svg?
   :target: https://codecov.io/github/sprockets/sprockets.handlers.status?branch=master

.. |Downloads| image:: https://img.shields.io/pypi/dm/sprockets.handlers.status.svg?
   :target: https://pypi.python.org/pypi/sprockets.handlers.status

.. |License| image:: https://img.shields.io/pypi/l/sprockets.handlers.status.svg?
   :target: https://sprockets.handlers.status.readthedocs.org