parent
ccb6b85265
commit
7f319b95cb
@ -1 +1,32 @@ |
|||||||
PyHmy is a wrapper tool to use Harmony's CLI in python. |
# Pyhmy - Harmony's python utilities |
||||||
|
|
||||||
|
**This library is for python3 only.** |
||||||
|
|
||||||
|
[Full documentation is located on Harmony's GitBook](https://harmony.one/) (in progress). |
||||||
|
|
||||||
|
A Python library for interacting and working the [Harmony blockchain](https://harmony.one/) |
||||||
|
and [related codebases](https://github.com/harmony-one). |
||||||
|
|
||||||
|
## Installation |
||||||
|
```bash |
||||||
|
pip install pyhmy |
||||||
|
``` |
||||||
|
|
||||||
|
## Development |
||||||
|
Clone the repository and then run the following to install the dependencies: |
||||||
|
```bash |
||||||
|
python3 -m pip install requests |
||||||
|
python3 -m pip install pexpect |
||||||
|
``` |
||||||
|
(Optional) Copy over the CLI binary into `<pyhmy_project_dir>/bin/`. Reference |
||||||
|
[here](https://app.gitbook.com/@harmony-one/s/home/command-line-interface/using-the-harmony-cli-tool) |
||||||
|
for more details on the Harmony CLI. *Note that this library comes with a function (under the `pyhmy.utils`) |
||||||
|
to download the statically linked CLI for Linux and MacOS*. |
||||||
|
|
||||||
|
## Running tests |
||||||
|
|
||||||
|
TODO testing flow using pytest |
||||||
|
|
||||||
|
## Releasing |
||||||
|
|
||||||
|
TODO Automated release flow with proper versioning. |
Loading…
Reference in new issue