DS8000 Python Client
This repository contains the IBM RESTful API Python client, which establishes terminal connection with IBM DS8000 storage systems. The Python client protocol enables full management and monitoring of these storage arrays by issuing dedicated RESTful APIs.
Python Compatibility
The content in this collection supports Python 3.9 and newer.
Getting started
Clone the repository, and then add it to your PYTHONPATH directory. The Python client is then ready for import and use. The library is also available to install using pip. See the pypi pyds8k project
To install via pip run the following command:
pip install pyds8k
Documentation
Documentation for the pyds8k library can be generated using sphinx. The documentation for the latest release is also available via pyds8k.readthedocs.io
NOTE: To view older versions of the doc, click on the link at the bottom right corner in the readthedocs link and select the desired version.
Usage examples
Usage examples of the Python client are available in the examples.py file.
Displaying the RESTful APIs reference information
Each storage system of DS8000 and major software version has its own set of RESTful APIs. The RESTful APIs are detailed in the RESTful API reference guides that are available on IBM Knowledge Center (KC).
To display the full RESTful API Reference Guide of a specific storage system and a specific software version:
-
Navigate to a storage system welcome page on KC:
-
On the welcome page, select a storage system software version. For example, select Version 8.5.3.
The welcome page of the selected software version is displayed.
-
If needed, select the Table of contents tab.
-
On the table of contents, click RESTful API.
-
Refer to Host commands and to all subsequent chapters.
Contributing
We do not accept any contributions at the moment. This may change in the future, so you can fork, clone, and suggest a pull request.
Running tests
Use tox to run the test suite
tox
Use pytest to run tests or a specific test.
pytest --cov-config=.coveragerc --cov pyds8k --disable-warnings -v
pytest --cov-config=.coveragerc --cov pyds8k --disable-warnings -v pyds8k/test/test_resources/test_ds8k/test_host.py
4 maintainers
Metadata
4 maintainers
Release files for pyds8k 1.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pyds8k-1.6.0.tar.gz | 90.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyds8k-1.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 262.2 kB
Release files / pyds8k-1.6.0.tar.gz
| Download URL | pyds8k-1.6.0.tar.gz |
|---|---|
| Size | 90.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
70d050edb67f76b0e929e779672568db941ddad3b0cd79ff15aacb9d645230d0
|
|
BLAKE2b-256 checksum How to use checksums |
4af59d03d3a035d605e341050218310f35862419eb2db83d4bad63daf1a8f9d6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / pyds8k-1.6.0-py3-none-any.whl
| Download URL | pyds8k-1.6.0-py3-none-any.whl |
|---|---|
| Size | 171.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2024628ea01844421955fdd6524381ccd481d22f4829ea11f4654698210c2a77
|
|
BLAKE2b-256 checksum How to use checksums |
a645bfaf359bcb67e5d68f383287c46076595bfef56d582b6f693add9d004311
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for pyds8k 1.6.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
