Skip to content

Commit 5e3726c

Browse files
authored
Merge pull request #75 from NethermindEth/ndatta/quick-start-and-other-changes
Ndatta/quick start and other changes
2 parents cf52a1d + ee4aa93 commit 5e3726c

File tree

20 files changed

+161
-931
lines changed

20 files changed

+161
-931
lines changed

vocs-docs/docs/pages/indexer-client/http/accounts/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ import GetRewardsAggregated from './get_rewards_aggregated.mdx'
2525
<ListPositions />
2626
<GetAssetPositions />
2727
<GetTransfers />
28+
<GetTransfersBetween />
2829
<ListOrders />
2930
<GetOrder />
3031
<GetFills />
@@ -34,7 +35,6 @@ import GetRewardsAggregated from './get_rewards_aggregated.mdx'
3435
<GetParentSubaccount />
3536
<ListParentPositions />
3637
<GetParentAssetPositions />
37-
<GetTransfersBetween />
3838
<GetParentTransfers />
3939
<ListParentOrders />
4040
<GetParentFills />

vocs-docs/docs/pages/interaction/client/quick-start-py.mdx

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -16,40 +16,6 @@ Choose and install [Python 3.9+](https://www.python.org/downloads/) and [Poetry]
1616
git clone https://github.com/dydxprotocol/v4-clients.git
1717
```
1818

19-
## Set up virtual environment (Only for Linux)
20-
21-
It's a good practice to use virtual environment to isolate dependencies for a project. Run the following command to create virtual environment.
22-
23-
```bash
24-
python -m venv myenv
25-
```
26-
27-
Activate the virtual environment:
28-
29-
```bash
30-
source myenv/bin/activate
31-
```
32-
33-
After activation, you should see the environment name in the terminal prompt, indicating you are in a virtual environment.
34-
35-
## Adding the `dydx` Dependency
36-
37-
Use the `pip install` command to add the dependencies. It will install the latest version of the client.
38-
39-
```bash
40-
pip install dydx-v4-client
41-
```
42-
43-
For more details on the `dydx-v4-client` library installation, please check the [readme of the python client](https://github.com/dydxprotocol/v4-clients/tree/main/v4-client-py-v2/README.md).
44-
45-
## Install poetry
46-
47-
The `dydx` uses `poetry` library for dependency management. Install the poetry using `pip`.
48-
49-
```bash
50-
pip install poetry
51-
```
52-
5319
## Install all dependencies
5420

5521
Go to the Python client library.
@@ -69,7 +35,7 @@ poetry install
6935
Now, we can run an example file. Let's run `example/accounts_endpoint.py` file.
7036

7137
```bash
72-
python examples/account_endpoints.py
38+
poetry run python -m examples.account_endpoints
7339
```
7440

7541
::::

0 commit comments

Comments
 (0)