statuscake-py 1.0.0b4

StatusCake API

NOTE: This library is in alpha and not production ready. Whilst it can be used we will not offer support until it is generally available.

The Python implementation of the StatusCake API client. Documentation for this library can be found here.

Prerequisites

You will need the following things properly installed on your computer.

• Python: any one of the three latest major releases

Installation

PyPi

Using PyPi, add the following to requirement.txt:

statuscake_py

And then execute:

$ pip install -r requirements.txt

Or install it yourself:

$ pip install statuscake_py

GitHub

Installing the latest version from Github:

$ git clone https://github.com/StatusCakeDev/statuscake-py
$ cd statuscake-py
$ python setup.py install

Usage

Import the module from any Python file, instantiate an API client and execute a request:

from statuscake import ApiClient
from statuscake.apis import (
    ContactGroupApu,
    LocationsApi,
    MaintenanceWindowsApi,
    PagespeedApi,
    SslApi,
    UptimeApi,
)

client = ApiClient(
   header_name='Authorization',
   header_value='Bearer %s' % api_token,
)

service = UptimeApi(api_client=client)
service.list_uptime_tests()

License

This project is licensed under the MIT License.