Metadata-Version: 2.1
Name: dfir_iris_client
Version: 1.0.3
Summary: Client for DFIR-IRIS API
Home-page: https://github.com/dfir-iris/dfir-iris-client
Author: DFIR-IRIS
Author-email: contact@dfir-iris.org
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Python client

`dfir_iris_client` offers a Python interface to communicate with IRIS.

It relies exclusively on the API, which means output of the methods are the same as specified in the API reference.

## Versions
The Python client version follows the API versions (until the patch level). Meaning for API v1.0.1, one need to install `dfir_iris_client-1.0.1`. 
Please refer to the [documentation](https://dfir-iris.github.io/operations/api/#references) to check which version applies to your IRIS instance. 

## Install 
IRIS Client is now part of PyPI. You can simply install it with : 
```
pip3 install dfir-iris-client
```

## Build
To build a wheel from the sources:

1. `pip3 install wheel`
2. `python setup.py bdist_wheel`
3. `pip3 install dist/XXX.whl`


## Examples
Some examples are available [here](https://github.com/dfir-iris/iris-client/tree/master/examples).

## Documentation 
The documentation is available in the [IRIS documentation](https://dfir-iris.github.io/python_client/).


