https://github.com/statuscakedev/statuscake-py
StatusCake Python SDK (Alpha)
https://github.com/statuscakedev/statuscake-py
api-client statuscake
Last synced: 7 months ago
JSON representation
StatusCake Python SDK (Alpha)
- Host: GitHub
- URL: https://github.com/statuscakedev/statuscake-py
- Owner: StatusCakeDev
- License: mit
- Created: 2022-02-24T21:48:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-31T13:43:40.000Z (about 1 year ago)
- Last Synced: 2025-04-18T07:51:49.184Z (7 months ago)
- Topics: api-client, statuscake
- Language: Python
- Homepage: https://developers.statuscake.com
- Size: 146 KB
- Stars: 1
- Watchers: 4
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.rst
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
statuscake-py |build|
=====================
**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``:
.. code:: python
statuscake_py
And then execute:
.. code:: bash
pip install -r requirements.txt
Or install it yourself:
.. code:: bash
pip install statuscake_py
GitHub
------
Installing the latest version from Github:
.. code:: bash
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:
.. code:: python
from statuscake import ApiClient
from statuscake.apis import (
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 `_.
.. |build| image:: https://github.com/StatusCakeDev/statuscake-py/workflows/test/badge.svg