semvec/pypi-packages huggingface dataset:
pyds8k 1.6.0
DS8000 Python Client
Requires Python: >=3.9
Keywords: IBM, DS8000 Storage

# DS8000 Python Client

[![Build Status](https://github.com/IBM/pyds8k/actions/workflows/main.yml/badge.svg?branch=develop)](https://github.com/IBM/pyds8k/actions/workflows/main.yml)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5884/badge)](https://bestpractices.coreinfrastructure.org/projects/5884)
[![Documentation Status](https://readthedocs.org/projects/pyds8k/badge/?version=latest)](https://pyds8k.readthedocs.io/en/latest/?badge=latest)

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](https://pypi.org/project/pyds8k/)

To install via pip run the following command:

```shell
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](https://pyds8k.readthedocs.io/en/latest)

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:

1. Navigate to a storage system welcome page on KC:

2. On the welcome page, select a storage system software version. For example, select **Version 8.5.3**.

    ![Software version](images/1.jpg)

    The welcome page of the selected software version is displayed.

3. If needed, select the **Table of contents** tab.

    ![Table of contents](images/2.jpg)

4. On the table of contents, click **RESTful API**.

    ![CLI interface](images/3.jpg)

5. 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

```shell
tox
```

Use pytest to run tests or a specific test.

```shell
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
```