https://github.com/amureki/statuscheck

Tool to check PAAS/SAAS status pages (API+CLI)
https://github.com/amureki/statuscheck

api cli python status statuscheck statuspage

Last synced: 13 days ago
JSON representation

Tool to check PAAS/SAAS status pages (API+CLI)

• Host: GitHub
• URL: https://github.com/amureki/statuscheck
• Owner: amureki
• License: other
• Created: 2018-10-21T14:07:09.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T04:57:28.000Z (over 1 year ago)
• Last Synced: 2024-10-16T11:41:22.379Z (29 days ago)
• Topics: api, cli, python, status, statuscheck, statuspage
• Language: Python
• Homepage:
• Size: 453 KB
• Stars: 34
• Watchers: 4
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# statuscheck: Tool to check PAAS/SAAS status pages

[![Tests](https://github.com/amureki/statuscheck/workflows/Tests/badge.svg)](https://github.com/amureki/statuscheck/actions)

[![image](https://img.shields.io/pypi/v/statuscheck.svg)](https://pypi.org/project/statuscheck/)

[![image](https://img.shields.io/pypi/l/statuscheck.svg)](https://github.com/amureki/statuscheck/blob/main/LICENSE)

[![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](https://pypi.org/project/statuscheck/):

    $ 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': 'Partial outage', 'id': ''}], 'incidents': [{'id': 879, 'name': "We're looking into an issue with certain API calls", 'status': 'active', 'components': [{'name': 'Apps/Integrations/APIs', 'status': 'Partial outage', 'id': ''}]}]}

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