Tideway

Simplified Python library for BMC Discovery API Interface that makes use of the Python Requests module https://github.com/psf/requests and uses the same response handler.

>>> import tideway
>>> tw = tideway.appliance('appliance-hostname','auth-token')
>>> tw.api_about.url
'https://appliance-hostname/api/about'
>>> tw.api_about.status_code
200
>>> tw.api_about.text
{
    "api_versions": [
        "1.0","1.1","1.2","1.3","1.4","1.5","1.6","1.7","1.8","1.9","1.10","1.11","1.12","1.13","1.14","1.15","1.16"
    ],
    "component": "REST API",
    "version":"DaaS",
    "product": "BMC Helix Discovery",
    "version": "25.2.00"
}

Tideway follows BMC Discovery's well-structured and documented REST API which can be viewed from https://<appliance>/swagger-ui/.

Tideway removes the extra layer of manually constructing a URL and parameters for python requests allowing you to query API supported features of Discovery seamlessly and faster than if you were to navigate via the GUI.

Documentation

Documentation can be found at https://traversys.github.io/Tideway/.

• Example notebook: notebooks/admin_api.ipynb (download via curl -O https://raw.githubusercontent.com/traversys/Tideway/main/notebooks/admin_api.ipynb)

Installation

• Tideway can be installed via PyPI:

$ python -m pip install tideway

• Tideway supports BMC Discovery 11.3+, API v1.0-1.16 using Python 3.

Releases