[readme] Update readme with testing docs

pull/2/head
Daniel Van Der Maden 5 years ago
parent eff1c43614
commit ab0a2e08be
  1. 20
      README.md

@ -2,25 +2,29 @@
**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/)
and [related codebases](https://github.com/harmony-one).
[Full documentation is located on Harmony's GitBook](https://harmony.one/) (in progress).
## 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
[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*.
for more details on the Harmony CLI.
> This library comes with a function (under the `pyhmy.utils`) to download the statically
linked CLI for Linux and MacOS.
## Running tests
@ -30,9 +34,15 @@ You can run all of the tests with the following:
make test
```
Or directly with `pytest` (reference [here](https://docs.pytest.org/en/latest/index.html) for more info):
```bash
py.test tests
```
## 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
make release

Loading…
Cancel
Save