Metadata-Version: 2.1
Name: gordo-client
Version: 6.2.4
Summary: Gordo client
Home-page: https://github.com/equinor/gordo-client
License: AGPL-3.0
Keywords: gordo-client
Author: Equinor ASA
Author-email: fg_gpl@equinor.com
Requires-Python: >=3.9,<4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Dist: PyYAML (>=5.3.1,<7)
Requires-Dist: click (>=7.0.0,<9.0.0)
Requires-Dist: gordo-core (>=0.3.0,<0.4.0)
Requires-Dist: pydantic (>=1.8.2,<2.0.0)
Requires-Dist: requests (>=2.20,<3.0)
Requires-Dist: simplejson (>=3.17.2,<4.0.0)
Requires-Dist: wrapt (>=1.11.0,<2.0.0)
Project-URL: Repository, https://github.com/equinor/gordo-client
Description-Content-Type: text/markdown

# Gordo client
Client for [Gordo](https://github.com/equinor/gordo) project.

[Documentation is available on Read the Docs](https://gordo-client.readthedocs.io/)

## Installation

At least python 3.9 need to be installed in the system first.

In order to install or uninstall this library run following commands.
```bash
# Install
pip install gordo-client

# Uninstall
pip uninstall gordo-client
```

## Developers Instructions

### Setup

Install [poetry](https://python-poetry.org/docs/#installation).

Setup and run development shell instance:

```console
> poetry install
> poetry shell
```

You could also install and apply [pre-commit](https://pre-commit.com/#usage) hooks.

Run `poetry install` to install or re-install all dependencies.

Run `poetry update` to update the locked dependencies to the most recent
version, honoring the constrains put inside `pyproject.toml`.

### Pre-commit

You could also install and apply [pre-commit](https://pre-commit.com/#usage) hooks.

### Run tests

Install [docker](https://docs.docker.com/engine/install/) (or similar container manager) if you want to run test-suite.

Run tests (except docker-related ones):

```console
> poetry run pytest -n auto -m "not dockertest"
```

Run docker-related tests:
```console
> poetry run pytest -m "dockertest"
```

