Metadata-Version: 2.1
Name: statuscheck
Version: 3.2.0
Summary: Tool to check PaaS/SaaS status pages
Home-page: https://github.com/amureki/statuscheck
Author: Rust Saiargaliev
Author-email: hi@amureki.me
License: Apache Software License 2.0
Keywords: statuscheck
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Requires-Dist: Click (==7.1.2)
Requires-Dist: httpx (==0.14.2)
Requires-Dist: attrs (==20.1.0)
Provides-Extra: tests
Requires-Dist: coverage ; extra == 'tests'
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: respx ; extra == 'tests'



# statuscheck: Tool to check PAAS/SAAS status pages

![Tests](https://github.com/amureki/statuscheck/workflows/Tests/badge.svg)
[![image](https://img.shields.io/pypi/v/statuscheck.svg)](https://pypi.org/project/statuscheck/)
[![image](https://img.shields.io/pypi/l/statuscheck.svg)](https://pypi.org/project/statuscheck/)
[![image](https://img.shields.io/pypi/pyversions/statuscheck.svg)](https://pypi.org/project/statuscheck/)
[![Coverage Status](https://coveralls.io/repos/github/amureki/statuscheck/badge.svg)](https://coveralls.io/github/amureki/statuscheck)

## Usage

Install the latest release:

    $ pip install statuscheck

Then just use it in your shell:

    $ statuscheck github
    Current GitHub status: All Systems Operational

    $ statuscheck slack
    Current Slack status: Active incident
    Registered events:
    - [active] We are investigating an issue with notification settings
    - [active] We're looking into an issue with certain API calls

    More: https://status.slack.com/

There is also an API available:


    >>> from statuscheck.utils import get_statuscheck_api

    >>> api = get_statuscheck_api('slack')
    >>> summary = api.get_summary()
    >>> summary.status
    Status(code='active', name='Minor incident', description='Minor incident', is_ok=False)
    >>> summary.incidents
    [Incident(id=879, name="We're looking into an issue with certain API calls", status='active', components=[Component(name='Apps/Integrations/APIs', status='', id='')])]
    >>> summary.as_dict()
    {'status': {'code': 'active', 'name': 'Minor incident', 'description': 'Minor incident', 'is_ok': False}, 'components': [{'name': 'Apps/Integrations/APIs', 'status': '', 'id': ''}], 'incidents': [{'id': 879, 'name': "We're looking into an issue with certain API calls", 'status': 'active', 'components': [{'name': 'Apps/Integrations/APIs', 'status': '', 'id': ''}]}]}


Currently, all services that we support are defined [here](statuscheck/services/__init__.py).


