Metadata-Version: 2.1
Name: exabyte-api-client
Version: 2020.10.19
Summary: Exabyte Python Client for RESTful API
Home-page: http://github.com/Exabyte-io/exabyte-api-client
Author: Exabyte Inc.
Author-email: info@exabyte.io
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests (==2.20.1)
Provides-Extra: test
Requires-Dist: mock (==1.3.0) ; extra == 'test'

This package provides access to Exabyte.io [RESTful API](https://docs.exabyte.io/rest-api/overview/).

# Installation

We recommend creating a virtual environment before installing:

```bash
virtualenv my-virtualenv
source my-virtualenv/bin/activate
```

Install using pip:

- from PyPI:

```bash
pip install exabyte-api-client
```

- from source code in development mode:

```bash
git clone git@github.com:Exabyte-io/exabyte-api-client.git
cd exabyte-api-client
pip install -e .
```

# Examples

[exabyte-api-examples](https://github.com/Exabyte-io/exabyte-api-examples) repository contains examples for performing most-common tasks in the Exabyte.io platform through its RESTful API in Jupyter Notebook format.

# Testing
A Virtualenv environment can be created and the tests run with the included `run-tests.sh` script.
To run the unit tests in Python 3, you can:
```
./run-tests -t=unit
```

To run the integration tests in Python 2, you can:
```
./run-tests -p=python3 -t=integration
```
(assuming you have a `python3` binary in your PATH environment).

Note that the integration tests require a web service against which you can direct the live tests. See `tests/integration/__init__.py` for the environment variable details you need to set up for the integration tests.


© 2018 Exabyte Inc.


