Metadata-Version: 2.1
Name: iota-client
Version: 1.0.0rc2
Summary: Python bindings for the IOTA client library
Keywords: iota,tangle,client,python
Home-Page: https://www.iota.org/
Author: IOTA Stiftung
License: Apache-2.0
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Source Code, https://github.com/iotaledger/iota.rs

# IOTA Client Library - Python binding

Python binding to the iota.rs client library.

## Requirements

[Python 3.x](https://www.python.org) & [pip](https://pypi.org/project/pip)

`Rust` and `Cargo`, to compile the binding. Install them [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).

## Installation

- Go to `iota.rs/bindings/python`

### Create a virtual environment and use it (optional)
- `python3 -m venv iota_client_venv`
- `source iota_client_venv/bin/activate`; Windows: `.\iota_client_venv\Scripts\activate`

### Install required dependencies and build the wheel
- `pip install -r requirements-dev.txt`
- `pip install .`

### Run examples
`python3 examples/[example file]`

Example: 
- `python3 examples/00_get_info.py`

### To deactivate the virtual environment (optional)
- `deactivate`

## Getting Started

After you installed the library, you can create a `IotaClient` instance and interface with it.

```python
from iota_client import IotaClient

# Create an IotaClient instance
client = IotaClient({'nodes': ['https://api.testnet.shimmer.network']})

# Get the node info
node_info = client.get_info()
print(f'{node_info}')
```

## Build docs
`pydoc-markdown -p iota_client > ../../../documentation/docs/libraries/python/api_reference.md`

