Skip to content

Commit 504e22e

Browse files
authored
Update README.md
1 parent 3cf5907 commit 504e22e

1 file changed

Lines changed: 10 additions & 27 deletions

File tree

README.md

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,7 @@ This MVP Python client enables the execution of **[WebAssembly](https://en.wikip
1111

1212
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.
1313

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.
15-
16-
| Feature | [Python](https://github.com/polywrap/python-client) | [Javascript](https://github.com/polywrap/toolchain) | [Go]() | [Rust](https://github.com/polywrap/rust-client) |
17-
| -- | -- | -- | -- | -- |
18-
| Invoke ||| | |
19-
| Subinvoke | ⚙️ || | |
20-
| Interfaces ||| | |
21-
| Env Configuration | ⚙️ || | |
22-
| Client Config | ⚙️ || | |
23-
| Plugins ||| | |
24-
| Wrap Manifest | ⚙️ || | |
25-
| Uri Resolution | ⚙️ || | |
26-
> 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.
3315

3416

3517
# Getting Started:
@@ -53,7 +35,8 @@ For detailed information about Polywrap and the WRAP standard, visit our [develo
5335
> - 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.
5436
5537
### `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
5740
> ```
5841
> brew install poetry
5942
> ```
@@ -66,7 +49,7 @@ For detailed information about Polywrap and the WRAP standard, visit our [develo
6649
## Poetry
6750
6851
- 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.
7053
7154
- For example, we can **install** deps, **build** and **test** the `polywrap-msgpack` package using Poetry.
7255
@@ -82,12 +65,13 @@ In order to assure the integrity of the modules Polywrap Python Client uses [pyt
8265
8366
- 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.
8467
- 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
8670
```
8771
poetry build
8872
```
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
9175
```
9276
poetry shell
9377
```
@@ -113,7 +97,7 @@ tests/test_msgpack.py ........................
11397

11498
> ### Debugging with Pytest:
11599
>
116-
> 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:
117101
> - `poetry run pytests -v` or `poetry run pytests -vv` for even more detail
118102
> - Reach out to the devs on the [Discord](https://discord.polywrap.io) explaining your situation, and what configuration you're using on your machine.
119103
@@ -129,7 +113,6 @@ tox -a
129113
```
130114
tox
131115
```
132-
133116
### Linting
134117
```
135118
tox -e lint
@@ -255,4 +238,4 @@ The Polywrap project is completely open-source and we welcome contributors of al
255238
- [Polywrap Documentation](https://docs.polywrap.io)
256239
- [Polywrap Integrations Repository](https://github.com/polywrap/integrations)
257240
- [Running operations concurrently with python's asyncio](https://realpython.com/async-io-python/#the-10000-foot-view-of-async-io)
258-
- [Intro Video](TODO)
241+
- [Intro Video](TODO)

0 commit comments

Comments
 (0)