|
|
|
@ -9,14 +9,14 @@ and [related codebases](https://github.com/harmony-one). |
|
|
|
|
|
|
|
|
|
## Installation |
|
|
|
|
|
|
|
|
|
```bash |
|
|
|
|
``` |
|
|
|
|
pip install pyhmy |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## Development |
|
|
|
|
|
|
|
|
|
Clone the repository and then run the following: |
|
|
|
|
```bash |
|
|
|
|
``` |
|
|
|
|
make install |
|
|
|
|
``` |
|
|
|
|
(Optional) Copy over the CLI binary into `<pyhmy_repo_directory>/bin/`. Reference |
|
|
|
@ -30,13 +30,13 @@ linked CLI for Linux and MacOS. |
|
|
|
|
|
|
|
|
|
You can run all of the tests with the following: |
|
|
|
|
|
|
|
|
|
```bash |
|
|
|
|
``` |
|
|
|
|
make test |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
Or directly with `pytest` (reference [here](https://docs.pytest.org/en/latest/index.html) for more info): |
|
|
|
|
|
|
|
|
|
```bash |
|
|
|
|
``` |
|
|
|
|
py.test tests |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
@ -44,6 +44,11 @@ py.test tests |
|
|
|
|
|
|
|
|
|
You can release this library with the following command (assuming you have the credentials to upload): |
|
|
|
|
|
|
|
|
|
```bash |
|
|
|
|
``` |
|
|
|
|
make release |
|
|
|
|
``` |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
TODO: Rework the benchmark, do the reformatting first before tieing everything together and debugging. |
|
|
|
|
TODO: For benchmark, make sure to include documentation that one has to update the `pip install pyhmy==20.1.0` version! |
|
|
|
|
TODO: sample of how to use the library, reference Tezos. |
|
|
|
|
TODO: start (and finish) some of the documentation. |
|
|
|
|