|
|
@ -2,25 +2,29 @@ |
|
|
|
|
|
|
|
|
|
|
|
**This library is for python 3 only.** |
|
|
|
**This library is for python 3 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/) |
|
|
|
A Python library for interacting and working the [Harmony blockchain](https://harmony.one/) |
|
|
|
and [related codebases](https://github.com/harmony-one). |
|
|
|
and [related codebases](https://github.com/harmony-one). |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[Full documentation is located on Harmony's GitBook](https://harmony.one/) (in progress). |
|
|
|
|
|
|
|
|
|
|
|
## Installation |
|
|
|
## Installation |
|
|
|
|
|
|
|
|
|
|
|
```bash |
|
|
|
```bash |
|
|
|
pip install pyhmy |
|
|
|
pip install pyhmy |
|
|
|
``` |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
## Development |
|
|
|
## Development |
|
|
|
|
|
|
|
|
|
|
|
Clone the repository and then run the following: |
|
|
|
Clone the repository and then run the following: |
|
|
|
```bash |
|
|
|
```bash |
|
|
|
make install |
|
|
|
make install |
|
|
|
``` |
|
|
|
``` |
|
|
|
(Optional) Copy over the CLI binary into `<pyhmy_repo_directory>/bin/`. Reference |
|
|
|
(Optional) Copy over the CLI binary into `<pyhmy_repo_directory>/bin/`. Reference |
|
|
|
[here](https://app.gitbook.com/@harmony-one/s/home/command-line-interface/using-the-harmony-cli-tool) |
|
|
|
[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`) |
|
|
|
for more details on the Harmony CLI. |
|
|
|
to download the statically linked CLI for Linux and MacOS*. |
|
|
|
|
|
|
|
|
|
|
|
> This library comes with a function (under the `pyhmy.utils`) to download the statically |
|
|
|
|
|
|
|
linked CLI for Linux and MacOS. |
|
|
|
|
|
|
|
|
|
|
|
## Running tests |
|
|
|
## Running tests |
|
|
|
|
|
|
|
|
|
|
@ -30,9 +34,15 @@ You can run all of the tests with the following: |
|
|
|
make test |
|
|
|
make test |
|
|
|
``` |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Or directly with `pytest` (reference [here](https://docs.pytest.org/en/latest/index.html) for more info): |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```bash |
|
|
|
|
|
|
|
py.test tests |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
## Releasing |
|
|
|
## Releasing |
|
|
|
|
|
|
|
|
|
|
|
You can release this library with the following command (assuming you have credentials to upload): |
|
|
|
You can release this library with the following command (assuming you have the credentials to upload): |
|
|
|
|
|
|
|
|
|
|
|
```bash |
|
|
|
```bash |
|
|
|
make release |
|
|
|
make release |
|
|
|