Skip to main content
Help us improve Python packaging – donate today!

A very simple package for checking the status of a service and its components

Project Description

==============
Status Checker
==============


.. image:: https://img.shields.io/pypi/v/pystatuschecker.svg
:target: https://pypi.python.org/pypi/pystatuschecker

.. image:: https://img.shields.io/travis/timmartin19/pystatuschecker.svg
:target: https://travis-ci.org/timmartin19/pystatuschecker

.. image:: https://readthedocs.org/projects/pystatuschecker/badge/?version=latest
:target: https://status-checker.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://pyup.io/repos/github/timmartin19/pystatuschecker/shield.svg
:target: https://pyup.io/repos/github/timmartin19/pystatuschecker/
:alt: Updates


A very simple package for checking the status of a service and its components


* Free software: MIT license
* Documentation: https://pystatuschecker.readthedocs.io.


Examples
--------

.. code-block:: python

from status_checker import StatusChecker

def check_database(config):
# ... check if it's up and either return a dictionary like
# {'available': <bool>} or throw an exception

def check_other_service(config):
# ... same as above

status_checker = StatusChecker(database=check_database, other_service=check_other_service)
status_dict = status_checker.status(config)

The status_dict include the state of the components
in the 'components' key, the `failure_count`, and the `status`
of the service as a whole

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

Release history Release notifications

This version
History Node

0.1.2

History Node

0.1.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
py_status_checker-0.1.2-py3-none-any.whl (3.7 kB) Copy SHA256 hash SHA256 Wheel py3 Jul 7, 2016
py-status-checker-0.1.2.tar.gz (3.0 kB) Copy SHA256 hash SHA256 Source None Jul 7, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page