<commit_before>#################################
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 <YOUR-PACKAGE>.healthchecks


**************
Project status
**************

`hospital` is not full-featured yet. Some important features are in the
`roadmap <https://github.com/python-hospital/hospital/issues/milestones>`_.
See also `vision
<http://hospital.readthedocs.org/en/latest/about/vision.html>`_.

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


*********
Resources
*********

* Documentation: https://hospital.readthedocs.org
* IRC: ``#python-hospital`` on freenode
* Mailing-list: ``<EMAIL>``,
  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/issues/milestones<commit_msg>Fixed dead link.<commit_after>#################################
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 <YOUR-PACKAGE>.healthchecks


**************
Project status
**************

`hospital` is not full-featured yet. Some important features are in the
`roadmap <https://github.com/python-hospital/hospital/issues/milestones>`_.
See also `vision
<http://hospital.readthedocs.org/en/latest/about/vision.html>`_.

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


*********
Resources
*********

* Documentation: https://hospital.readthedocs.org
* IRC: ``#python-hospital`` on freenode
* Mailing-list: ``<EMAIL>``,
  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
{'fraction_non_alphanumeric': 0.1550491510277033, 'fraction_numerical': 0.0035746201966041107, 'mean_word_length': 4.791720569210867, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 16, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1612819', 'n_tokens_mistral': 1317, 'n_tokens_neox': 1196, 'n_words': 387}