You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-27Lines changed: 10 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,25 +11,7 @@ This MVP Python client enables the execution of **[WebAssembly](https://en.wikip
11
11
12
12
The client is built following the functionality of the [JavaScript Polywrap Client](https://github.com/polywrap/toolchain), which is currently more robust and battle tested, as it has additional capabilities than this MVP. In the future, the Polywrap DAO will continue improving this Python capabilities to reach feature parity with the JS stack, while building in parallel clients for other languages like Go and Rust.
13
13
14
-
Here you can see which features have been implemented on each language, and make the decision of which one to use for your project.
> TODO: Update table above according to test harness and maybe mention other wip clients (go, rust)
27
-
28
-
|status||
29
-
| -- | -- |
30
-
|✅ | fully working|
31
-
|⚙️| partially working|
32
-
|❌|not yet implemented|
14
+
[Here](https://github.com/polywrap/client-test-harness) you can see which features have been implemented on each language, and make the decision of which one to use for your project.
33
15
34
16
35
17
# Getting Started:
@@ -53,7 +35,8 @@ For detailed information about Polywrap and the WRAP standard, visit our [develo
53
35
> - If you are using a Linux system or WSL, which comes with Python3.8, then you will need to upgrade from Python3.8 to Python3.10 and also fix the `pip` and `distutil` as upgrading to Python3.10 will break them. You may follow [this guide](https://cloudbytes.dev/snippets/upgrade-python-to-latest-version-on-ubuntu-linux) to upgrade.
54
36
55
37
### `poetry ^1.1.14`
56
-
> - To install poetry follow [this guide](https://python-poetry.org/docs/#installation). If you are on MacOS then you can install poetry simply with the following homebrew command
38
+
> - To install poetry follow [this guide](https://python-poetry.org/docs/#installation).
39
+
> - If you are on MacOS then you can install poetry simply with the following homebrew command
57
40
> ```
58
41
> brew install poetry
59
42
> ```
@@ -66,7 +49,7 @@ For detailed information about Polywrap and the WRAP standard, visit our [develo
66
49
## Poetry
67
50
68
51
- We will be using [Poetry](https://python-poetry.org) for building and testing our packages.
69
-
Each of the package folders consists the `pyproject.toml` file and the `poetry.lock` file. In `pyproject.toml` file, one can find out all the project dependencies and configs related to the package. These files will be utilized by Poetry to install correct dependencies, build, lint and test the package.
52
+
Each of the package folders consists of the `pyproject.toml` file and the `poetry.lock` file. In `pyproject.toml` file, one can find out all the project dependencies and configs related to the package. These files will be utilized by Poetry to install correct dependencies, build, lint and test the package.
70
53
71
54
- For example, we can **install** deps, **build** and **test** the `polywrap-msgpack` package using Poetry.
72
55
@@ -82,12 +65,13 @@ In order to assure the integrity of the modules Polywrap Python Client uses [pyt
82
65
83
66
- As we can see in the `pyproject.toml` files, we installed the [PyTest](https://docs.pytest.org) package. We will be using it as our testing framework.
84
67
- Now we are ready to **build** and **test** the core package using Poetry and PyTest.
85
-
- To build the package run the following command
68
+
69
+
To build the package run the following command
86
70
```
87
71
poetry build
88
72
```
89
-
- You need to activate the venv with poetry using the `shell` command before running any other command
90
-
73
+
74
+
You need to activate the venv with poetry using the `shell` command before running any other command
> You should expect to see the tests passing with a 100% accuracy. To better understand and read these outputs, check[this quick guide](https://docs.pytest.org/en/7.1.x/how-to/output.html). If anything fails (marked with an 'F'), or if there are any Warnings raised, you can debug them by running a verbose version of the test suite:
100
+
> You should expect to see the tests passing with a 100% accuracy. To better understand these outputs, read[this quick guide](https://docs.pytest.org/en/7.1.x/how-to/output.html). If any of the functionality fails (marked with an 'F'), or if there are any Warnings raised, you can debug them by running a verbose version of the test suite:
117
101
> -`poetry run pytests -v` or `poetry run pytests -vv` for even more detail
118
102
> - Reach out to the devs on the [Discord](https://discord.polywrap.io) explaining your situation, and what configuration you're using on your machine.
119
103
@@ -129,7 +113,6 @@ tox -a
129
113
```
130
114
tox
131
115
```
132
-
133
116
### Linting
134
117
```
135
118
tox -e lint
@@ -255,4 +238,4 @@ The Polywrap project is completely open-source and we welcome contributors of al
0 commit comments