Metadata-Version: 2.2
Name: hyperunison_public_api_sdk
Version: 1.2.1
Summary: Python SDK to use public API of Unison
Author-email: Konstantin Naumov <konstantin@hyperunison.com>
Project-URL: Homepage, https://github.com/Hyperunison/unison-sdk-python
Project-URL: Issues, https://github.com/Hyperunison/unison-sdk-python/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# Hyperunison Python SDK

You can use this SDK to execute UQL queries via Public API.

## Installation
If you need to install this SDK, you should add the line
```shell
hyperunison-public-api-sdk===1.1.8
```
to the file **requirements.txt**.

Or you can run the command
```shell
pip install hyperunison-public-api-sdk
```
in CLI.

## API keys

You will need to create API key to use the Public API. You can do it in Web interface of the site.

## The example of using

```python
from hyperunison_public_api import UnisonSDKApi
from hyperunison_public_api import Configuration

# Init variables
query = ''
api_key = ''
biobank_id = '1'
api = UnisonSDKApi(
    Configuration(
        host='',
    )
)

# Execute Cohort request
response = api.execute_cohort_request(
    api_key,
    biobank_id,
    query
)
print(response)

# Run custom workflow
api.run_custom_workflow(
    api_key=api_key,
    pipeline_version_id='0',
    parameters=list([]),
    project='',
    biobanks=list([]),
    cohort=''
)
```
