Metadata-Version: 2.1
Name: nibiru-py
Version: 0.0.5
Summary: Nibiru Python SDK
Home-page: https://github.com/NibiruChain/sdk-python
Author: Nibiru Chain
Author-email: dev@nibiru.fi
License: Apache Software License 2.0
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
License-File: LICENSE


## Nibiru Python SDK

### Dependencies

**Ubuntu**
```bash
sudo apt install python3.X-dev autoconf automake build-essential libffi-dev libtool pkg-config
```
**Fedora**
```bash
sudo dnf install python3-devel autoconf automake gcc gcc-c++ libffi-devel libtool make pkgconfig
```

**macOS**

```bash
brew install autoconf automake libtool
```

### Quick Start
Installation
```bash
pip install nibiru-py
```

### Usage
Requires Python 3.7+

[Examples](https://github.com/NibiruChain/sdk-python/tree/master/examples)
```bash
$ pipenv shell
$ pipenv install

# connecting to Nibiru Exchange API and create a new pool
$ python examples/chain_client/dex/create_pool.py

# sending a msg with bank transfer signs and posts a transaction to the Nibiru Chain
$ python examples/chain_client/msg_send.py
```
Upgrade `pip` to the latest version, if you see these warnings:
  ```
  WARNING: Value for scheme.platlib does not match. Please report this to <https://github.com/pypa/pip/issues/10151>
  WARNING: Additional context:   user = True   home = None   root = None   prefix = None
  ```

### Development
1. Enable dev env
  ```
  pipenv shell
  pipenv install --dev
  ```

2. Generate proto binding & build
  ```
  make proto-gen
  python -m build
  ```


3. Install pkg
  ```
  # from local build
  pip uninstall nibiru-py
  pip install nibiru-py --no-index --find-links /path/to/nibiru/sdk-python/dist

  # from pypi
  pip uninstall nibiru-py
  pip install nibiru-py
  ```
### Linting
Enable git hook which will perform linting before each commit:
```shell
pre-commit install
```
This will keep your code clean.

