Skip to main content

A python 3 client for the Cachet API

Project description

pypi travis Documentation Status


A python 3.6+ API client for the open source status page system Cachet.

The goal of this package is to create a user friendly interface to the Cachet API.

  • Resources are returned as objects clearly separating read only properties from the ones we can change. The raw json response is always available in an attrs property
  • Active use of type hints throughout the entire codebase making code completion a breeze
  • Proper pagination under the hood. Method listing resources will return generators. You can configure the start page and page size that fits the situation. Each new page leads to a new http request.
  • Client is using a single session regardless of resource type making more complex work a lot faster (connection reuse)
  • A very extensive set of tests/unit tests.
  • Easy to extend and test
  • Documentation

Please don't hesitate opening an issue about anything related to this package.


pip install cachet-client


import cachetclient
from cachetclient.v1 import enums

client = cachetclient.Client(

Check if api is responding

    print("Cachet is up and running!")

Create and delete a subscriber

sub = client.subscribers.create(email='user@example.test', verify=True)

List all subscribers paginated (generator). Each new page is fetched from the server under the hood.

for sub in client.subscribers.list(page=1, per_page=100):

Create a component issue

issue = client.incidents.create(
    name="Something blew up!",
    message="We are looking into it",
    # Optional for component issues,

.. and most other features supported by the Cachet API

Local Development

Local setup:

python -m virtualenv .venv
. .venv/bin/activate
pip install -e .


This project has a fairly extensive test setup.

  • Unit tests are located in tests/ including a fake implementation of the Cachet API.
  • A simpler test script under extras/ that needs a running test instance of Cachet.

Running unit tests

pip install -r tests/requirements.txt

# Optionally
tox -e pep8  # for pep8 run only
tox -e py36  # tests only

# Running tests with pytest also works, but this works poorly in combination with environment variables for the live test script (tox separates environments)
pytest tests/

Testing with real Cachet service

Do not run this script against a system in production. This is only for a test service. Cachet can easily be set up locally with docker:

Optionally we can run cachet from source:

A local setup is also located in the root or the repo (docker-compose.yaml).

You need to set the following environment variables.


Running tests:

python extras/
Number of tests   : 10
Successful        : 10
Failure           : 0
Percentage passed : 100.0%

Building Docs

pip install -r docs/requirements.txt
python build_sphinx


Do not hesitate opening issues or submit completed or partial pull requests. Contributors of all experience levels are welcome.

This project is sponsored by

Project details

Download files

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

Built Distribution

cachet_client-4.0.1-py3-none-any.whl (25.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page