Metadata-Version: 2.1
Name: openhexa.sdk
Version: 0.1.1
Summary: OpenHexa SDK
Home-page: https://github.com/BLSQ/openhexa-sdk-python
Author: Bluesquare
Author-email: dev@bluesquarehub.com
License: MIT License
Keywords: openhexa,pipelines
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: examples
License-File: LICENCE

# OpenHexa Python SDK

## Running the examples

Clone the repo and install the dependencies, including the ones required to run the examples:

```shell
git checkout https://github.com/BLSQ/openhexa-sdk-python.git
pip install ".[examples]"
```

Run a pipeline:

```shell
cd examples/pipelines/logistic_stats
python pipeline.py -c '{"deg":"qfxEYY9xAl6","periods":["2022Q1","2022Q2"]}'
```

Or using a config file:

```shell
cd examples/pipelines/logistic_stats
python pipeline.py -f example_conf.json
```

## Development & testing

Install the SDK in editable mode:

```shell
pip install -e ".[dev]"
```

Run the tests using pytest:

```shell
pytest
```
