https://github.com/python-hospital/hospital

Tools to diagnose Python projects (supervision, monitoring).
https://github.com/python-hospital/hospital

Last synced: 3 days ago
JSON representation

Tools to diagnose Python projects (supervision, monitoring).

• Host: GitHub
• URL: https://github.com/python-hospital/hospital
• Owner: python-hospital
• License: other
• Created: 2013-04-17T16:37:11.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-10-10T09:40:51.000Z (about 8 years ago)
• Last Synced: 2024-04-20T05:02:51.873Z (7 months ago)
• Language: Python
• Size: 1.04 MB
• Stars: 40
• Watchers: 4
• Forks: 8
• Open Issues: 13
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - hospital - Tools to diagnose Python projects (supervision, monitoring). (Python)

README

        
#################################

hospital: healthchecks for Python

#################################

`hospital` is a Python framework to write health checks, smoke tests or

diagnoses around applications or services.

********

Abstract

********

Health checks are kind of tests, applied to running applications and services:

* write healtchecks just as you would write tests, using assertions;

* collect and run healthchecks with test runners;

* use healthchecks to validate deployments;

* plug healthchecks in supervision and monitoring tools;

* in case of incidents, use healthchecks to diagnose problems.

*******

Example

*******

In your project's root package, have a ``healthchecks`` package or module,

where you assert your (running) application or service is ok:

.. code:: python

   import unittest

   import hospital

   @hospital.healthcheck

   class DocumentationHealthCheck(unittest.TestCase):

       def test_http_200(self):

           url = 'http://hospital.readthedocs.org/en/0.6/'

           hospital.assert_http_response(url, status_code=200)

Then you can collect and run the healthchecks with command line or web

service. Here is an example with command line:

.. code:: console

   $ hospital-cli .healthchecks

**************

Project status

**************

`hospital` is not full-featured yet. Some important features are in the

`roadmap `_. See also

`vision `_.

Of course, any ideas, feedback or help are welcome :)

*********

Resources

*********

* Documentation: https://hospital.readthedocs.org

* IRC: ``#python-hospital`` on freenode

* Mailing-list: ``[email protected]``,

  see archives at http://librelist.com/browser/pythonhospital/

* PyPI page: https://pypi.python.org/pypi/hospital

* Code repository: https://github.com/python-hospital/hospital

* Continuous integration: https://travis-ci.org/python-hospital/hospital

* Bugs & feature requests: https://github.com/python-hospital/hospital/issues

* Changelog: https://hospital.readthedocs.org/en/latest/about/changelog.html

* Roadmap: https://github.com/python-hospital/hospital/milestones