Skip to content

Commit 189c498

Browse files
author
abel
committed
(fix) Updated README file
1 parent 9c3bff0 commit 189c498

File tree

1 file changed

+12
-22
lines changed

1 file changed

+12
-22
lines changed

README.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ pip install injective-py
2626
```
2727

2828
### Usage
29-
Requires Python 3.7+
29+
Requires Python 3.9+
30+
Please install `poetry` following the steps described in the [documentation](https://python-poetry.org/docs/#installation)
3031

3132
[Examples](https://github.com/InjectiveLabs/sdk-python/tree/master/examples)
3233
```bash
33-
$ pipenv shell
34-
$ pipenv install
34+
$ poetry install
3535

3636
# connecting to Injective Exchange API
3737
# and listening for new orders from a specific spot market
38-
$ python examples/exchange_client/spot_exchange_rpc/8_StreamOrders.py
38+
$ poetry run python examples/exchange_client/spot_exchange_rpc/8_StreamOrders.py
3939

4040
# sending a msg with bank transfer
4141
# signs and posts a transaction to the Injective Chain
42-
$ python examples/chain_client/1_MsgSend.py
42+
$ poetry run python examples/chain_client/1_MsgSend.py
4343
```
4444
Upgrade `pip` to the latest version, if you see these warnings:
4545
```
@@ -51,16 +51,10 @@ Upgrade `pip` to the latest version, if you see these warnings:
5151
1. Generate proto binding & build
5252
```
5353
make gen
54-
python -m build
54+
poetry build
5555
```
5656

57-
2. Enable dev env
58-
```
59-
pipenv shell
60-
pipenv install --dev
61-
```
62-
63-
3. Install pkg
57+
2. Install pkg
6458
```
6559
# from local build
6660
pip uninstall injective-py
@@ -71,27 +65,23 @@ Upgrade `pip` to the latest version, if you see these warnings:
7165
pip install injective-py
7266
```
7367

74-
4. Fetch latest denom config
68+
3. Fetch latest denom config
7569
```
76-
python pyinjective/fetch_metadata.py
70+
poetry run python pyinjective/fetch_metadata.py
7771
```
7872

7973
Note that the [sync client](https://github.com/InjectiveLabs/sdk-python/blob/master/pyinjective/client.py) has been deprecated as of April 18, 2022. If you are using the sync client please make sure to transition to the [async client](https://github.com/InjectiveLabs/sdk-python/blob/master/pyinjective/async_client.py), for more information read [here](https://github.com/InjectiveLabs/sdk-python/issues/101)
8074

81-
5. Install the development environment (requires `pipenv`)
82-
```
83-
pipenv install -d
84-
```
85-
86-
6. Run all unit tests in a development environment
75+
4. Run all unit tests in a development environment
8776
```
88-
make tests
77+
poetry run pytest -v
8978
```
9079

9180
### Changelogs
9281
**0.9**
9382
* Replace Pipenv with Poetry
9483
* Add pre-commit validations to the project
84+
* Add a GitHub workflow to run all tests and calculate coverage for each PR
9585

9686
**0.8.5**
9787
* Added NEOK/USDT and ORAI/USDT spot markets to the mainnet .ini file

0 commit comments

Comments
 (0)