|
| 1 | +Inesonic SpeedSentry Python API |
| 2 | +=============================== |
| 3 | +This package provides a simple Python API you can use to communicate with |
| 4 | +Inesonic SpeedSentry infrastructure. You can use this API to: |
| 5 | + |
| 6 | +* Configure Inesonic SpeedSentry programmatically. |
| 7 | + |
| 8 | +* Query latency, SSL expiration data, and event histories associated with your Inesonic SpeedSentry subscription. |
| 9 | + |
| 10 | +* Pause and resume monitoring. |
| 11 | + |
| 12 | +* Trigger custom events, using Inesonic SpeedSentry to report those events to you. |
| 13 | + |
| 14 | +For details on Inesonic SpeedSentry, please goto https://speed-sentry.com. |
| 15 | + |
| 16 | +Developer Documentation |
| 17 | +----------------------- |
| 18 | +The API is designed to be simple to use. For details on how to integrate |
| 19 | +Inesonic SpeedSentry into your site or project, see |
| 20 | +https://speedsentry-documentation.inesonic.com |
| 21 | + |
| 22 | +Supported Python Versions |
| 23 | +------------------------- |
| 24 | +This API is specifically written to work with Python 3.5 and newer. |
| 25 | + |
| 26 | +Dependencies |
| 27 | +------------ |
| 28 | +The only external dependency required by this module is with the Python |
| 29 | +Requests package avaialble at https://pypi.org/project/requests/. If |
| 30 | +necessary, the supplied egg should automatically install any required |
| 31 | +dependencies. |
| 32 | + |
| 33 | +Installation |
| 34 | +------------ |
| 35 | +To install: |
| 36 | + |
| 37 | +* Clone or download this repository contents. |
| 38 | + |
| 39 | +* Enter the working copy's top level directory. |
| 40 | + |
| 41 | +* Run the command ``python3 setup.py install``. |
| 42 | + |
| 43 | +License And Support |
| 44 | +------------------- |
| 45 | +This package is licensed under the LGPLv3. |
| 46 | + |
| 47 | +You are welcome to submit patches and/or request new features either through |
| 48 | +GitHub or through SpeedSentry's internal support system. |
0 commit comments