From efce4aa44a9545b2b1d1c0be215583adf01d6dc2 Mon Sep 17 00:00:00 2001 From: James Jia - Test Date: Fri, 8 Sep 2023 14:23:01 -0700 Subject: [PATCH 1/6] Refresh READMEs --- README.md | 24 ++++++++++++++++++++++++ v4-client-js/README.md | 12 ++++++++++++ v4-client-js/package-lock.json | 4 ++-- v4-client-js/package.json | 2 +- v4-client-py/README.md | 21 +++++++++++---------- v4-client-py/pyproject.toml | 2 +- 6 files changed, 51 insertions(+), 14 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..734edd27 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +

+ +
+ + PyPI + + + PyPI + + + License + +
+
+ +# V4 Clients + +## v4-client-js +The V4-Client Typescript client is used for placing transactions and querying the dYdX chain. + +## v4-client-py +Python client for dYdX (v4 API). + +The library is currently tested against Python versions 3.9, and 3.11. \ No newline at end of file diff --git a/v4-client-js/README.md b/v4-client-js/README.md index eb56fbee..205a1c00 100644 --- a/v4-client-js/README.md +++ b/v4-client-js/README.md @@ -1,3 +1,15 @@ +

+ +
+ + PyPI + + + License + +
+
+ # V4 Client The V4-Client Typescript client is used for placing transactions and querying the dYdX chain. diff --git a/v4-client-js/package-lock.json b/v4-client-js/package-lock.json index d616d5c3..df3f7522 100644 --- a/v4-client-js/package-lock.json +++ b/v4-client-js/package-lock.json @@ -1,12 +1,12 @@ { "name": "@dydxprotocol/v4-client-js", - "version": "0.33.1", + "version": "0.33.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@dydxprotocol/v4-client-js", - "version": "0.33.1", + "version": "0.33.2", "license": "BSL-1.1", "dependencies": { "@cosmjs/amino": "^0.30.1", diff --git a/v4-client-js/package.json b/v4-client-js/package.json index b26b3818..25c9cf21 100644 --- a/v4-client-js/package.json +++ b/v4-client-js/package.json @@ -1,6 +1,6 @@ { "name": "@dydxprotocol/v4-client-js", - "version": "0.33.1", + "version": "0.33.2", "description": "General client library for the new dYdX system (v4 decentralized)", "main": "build/src/index.js", "scripts": { diff --git a/v4-client-py/README.md b/v4-client-py/README.md index 1a98452f..81768de7 100644 --- a/v4-client-py/README.md +++ b/v4-client-py/README.md @@ -1,11 +1,11 @@

- - PyPI + + PyPI - - License + + License

@@ -14,12 +14,12 @@ Python client for dYdX (v4 API). The library is currently tested against Python versions 3.9, and 3.11. -## Installation (TODO: modify after release) +## Installation -The `dydx-v4-python` package is available on [PyPI](https://pypi.org/project/dydx-v4-python). Install with `pip`: +The `v4-client-py` package is available on [PyPI](https://pypi.org/project/v4-client-py). Install with `pip`: ```bash -pip install dydx-v4-python +pip install v4-client-py ``` ## Getting Started @@ -29,16 +29,17 @@ Sample code is located in examples folder ## Development Setup - VS Code Install Microsoft Python extensions +``` Shift-Command-P: Create Python Environment Select Venv Select Python 3.9 as interpreter Select requirements.txt as the dependencies to install +``` -TODO: Add v4-proto to the requirements.txt -Install v4-proto +Install requirements ``` -pip install -i https://test.pypi.org/simple/ v4-proto== +pip install -r requirements.txt ``` VS Code will automatically switch to .venv environment when running example code. Or you can manually switch diff --git a/v4-client-py/pyproject.toml b/v4-client-py/pyproject.toml index e3524e1d..9f857169 100644 --- a/v4-client-py/pyproject.toml +++ b/v4-client-py/pyproject.toml @@ -5,7 +5,7 @@ package-dir = {"" = "v4_client_py"} [tool.poetry] name = "v4-client-py" -version = "0.4.0" +version = "0.4.1" description = "dYdX v4 Client" authors = ["John Huang "] license = "BSL-1.1" From 8a48d7830b62ca3f21ab6445979fd5ae57f877b2 Mon Sep 17 00:00:00 2001 From: James Jia - Test Date: Fri, 8 Sep 2023 14:24:31 -0700 Subject: [PATCH 2/6] Make logos friendly to both light/dark mode --- README.md | 2 +- v4-client-js/README.md | 2 +- v4-client-py/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 734edd27..5c9ca5da 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

+

diff --git a/v4-client-js/README.md b/v4-client-js/README.md index 205a1c00..d2fd9787 100644 --- a/v4-client-js/README.md +++ b/v4-client-js/README.md @@ -1,4 +1,4 @@ -

+

diff --git a/v4-client-py/README.md b/v4-client-py/README.md index 81768de7..53018e70 100644 --- a/v4-client-py/README.md +++ b/v4-client-py/README.md @@ -1,4 +1,4 @@ -

+

From 1be9dca96b681dd244f96297d0f614f1539d37a3 Mon Sep 17 00:00:00 2001 From: James Jia - Test Date: Fri, 8 Sep 2023 14:28:56 -0700 Subject: [PATCH 3/6] bump --- README.md | 9 ++++----- v4-client-js/README.md | 9 ++++----- v4-client-py/README.md | 7 ++++--- 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5c9ca5da..f21ade83 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -

+

-
+

V4 Clients

+ +
PyPI @@ -11,9 +13,6 @@ License
-
- -# V4 Clients ## v4-client-js The V4-Client Typescript client is used for placing transactions and querying the dYdX chain. diff --git a/v4-client-js/README.md b/v4-client-js/README.md index d2fd9787..a49f7335 100644 --- a/v4-client-js/README.md +++ b/v4-client-js/README.md @@ -1,6 +1,8 @@ -

+

-
+

V4 Client for Javascript

+ +
PyPI @@ -8,9 +10,6 @@ License
-
- -# V4 Client The V4-Client Typescript client is used for placing transactions and querying the dYdX chain. diff --git a/v4-client-py/README.md b/v4-client-py/README.md index 53018e70..11e95a00 100644 --- a/v4-client-py/README.md +++ b/v4-client-py/README.md @@ -1,6 +1,8 @@ -

+

-
+

V4 Client for Python

+ +
PyPI @@ -8,7 +10,6 @@ License
-
Python client for dYdX (v4 API). From 4be92fce6e14d7514471cc17f03f1a789ca59134 Mon Sep 17 00:00:00 2001 From: James Jia - Test Date: Fri, 8 Sep 2023 14:30:32 -0700 Subject: [PATCH 4/6] Fix --- README.md | 6 +++--- v4-client-js/README.md | 6 +++--- v4-client-py/README.md | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f21ade83..2c76ad3a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -

+

-

V4 Clients

+

V4 Clients

-
+
PyPI diff --git a/v4-client-js/README.md b/v4-client-js/README.md index a49f7335..50a44893 100644 --- a/v4-client-js/README.md +++ b/v4-client-js/README.md @@ -1,8 +1,8 @@ -

+

-

V4 Client for Javascript

+

V4 Client for Javascript

-
+
PyPI diff --git a/v4-client-py/README.md b/v4-client-py/README.md index 11e95a00..f4a7ba5a 100644 --- a/v4-client-py/README.md +++ b/v4-client-py/README.md @@ -1,8 +1,8 @@ -

+

-

V4 Client for Python

+

V4 Client for Python

-
+
PyPI From 9e4c1583bd714fac502f479737a84db2d34fbd91 Mon Sep 17 00:00:00 2001 From: James Jia - Test Date: Fri, 8 Sep 2023 14:55:27 -0700 Subject: [PATCH 5/6] lower case V for v4 --- README.md | 4 ++-- v4-client-js/README.md | 4 ++-- v4-client-py/README.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2c76ad3a..9e579bab 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

-

V4 Clients

+

v4 Clients

## v4-client-js -The V4-Client Typescript client is used for placing transactions and querying the dYdX chain. +The v4-Client Typescript client is used for placing transactions and querying the dYdX chain. ## v4-client-py Python client for dYdX (v4 API). diff --git a/v4-client-js/README.md b/v4-client-js/README.md index 50a44893..80c927db 100644 --- a/v4-client-js/README.md +++ b/v4-client-js/README.md @@ -1,6 +1,6 @@

-

V4 Client for Javascript

+

v4 Client for Javascript

 -The V4-Client Typescript client is used for placing transactions and querying the dYdX chain. +The v4-Client Typescript client is used for placing transactions and querying the dYdX chain. ## Development diff --git a/v4-client-py/README.md b/v4-client-py/README.md index f4a7ba5a..ac41c4ca 100644 --- a/v4-client-py/README.md +++ b/v4-client-py/README.md @@ -1,6 +1,6 @@

-

V4 Client for Python

+

v4 Client for Python