Metadata-Version: 2.1
Name: xchainpy-util
Version: 0.1.6
Summary: Utility helpers for XChain clients
Home-page: https://github.com/xchainjs/xchainpy-lib/tree/main/xchainpy/xchainpy_util
Author: THORChain
Author-email: 
License: MIT
Keywords: THORChain,XChainpy,xchainpy_util
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
License-File: LICENSE

# `xchainpy/xchainpy-util`

Utitity helpers for XChain clients

## Modules (in alphabetical order)

- `asset` - Utilities for handling assets
- `chain` - Utilities for multi-chain

-----------

## Usage

```bash
pip install xchainpy_util
```

Asset
-----------------

```python
from xchainpy_util.asset import Asset

asset = Asset(chain='BNB', symbol='RUNE-67C')
print(asset.chain)
print(asset.symbol)
print(asset.ticker)

asset = Asset(chain='BNB', symbol='RUNE-67C', ticker='RUNE')
print(asset)
 ```

Chain
-----------------

```python
from xchainpy_util import chain
from xchainpy_util.chain import Chain
is_chain = chain.is_chain(Chain.Binance)
print(is_chain)

is_chain = chain.is_chain('BNB')
print(is_chain)
 ```
    

## Tests

These packages needed to run tests:

- pytest `pip install pytest`

How to run tests?

```bash
$ python -m pytest xchainpy/xchainpy_util/tests
```



