Metadata-Version: 2.1
Name: ubirch-python-utils
Version: 1.3.7
Summary: A python util for ubirch anchoring services.
Home-page: https://github.com/ubirch/ubirch-python-utils
Author: Michael Merz
Author-email: dermicha@ubirch.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: kafka-python (>=1.4.3)
Requires-Dist: boto3 (>=1.7.80)

# ubirch library for ubirch anchoring services

This library contains several useful tools used to connect to a SQS or Kafka and anchor messages retrieved from a queue to the IOTA Tangle or the Ethereum Blockchain.

## Usage

### Configuration, connection to a Kafka server and retrieving queues.

To set up the different arguments needed to connect to the SQS Server and to access the ETH Wallet.
```python
from ubirch.anchoring_kafka import *

args = set_arguments(servicetype='ethereum') # Or 'IOTA'

#To access the Kafka server
port = args.port

#To unlock your wallet (if servicename=='ethereum')
password = args.pwd
keyfile = args.keyfile

queue1 = KafkaConsumer('queue1', bootstrap_servers=port)

```
### Polling a topic and processing its messages

Please see [ubirch-ethereum-service](https://github.com/ubirch/ubirch-ethereum-service/blob/master/ethereumService.py) or [ubirch-iota-service](https://github.com/ubirch/ubirch-iota-service/blob/master/iotaService.py) to how this library is put into action. 

### Testing

Unit tests are added to test the functionality of all objects provided in this library.

```bash
python3 -m unittest discover
``` 

# License 

This library is publicized under the [Apache License 2.0](LICENSE).

