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
+23-23Lines changed: 23 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
# Polywrap Python Client
4
4
5
-
## [Polywrap](https://polywrap.io) is a developer tool that enables easy integration of Web3 protocols into any application. It makes it possible for applications on any platform, written in any language, to read and write data to Web3 protocols.
5
+
[Polywrap](https://polywrap.io) is a developer tool that enables easy integration of Web3 protocols into any application. It makes it possible for applications on any platform, written in any language, to read and write data to Web3 protocols.
6
6
7
7
8
8
# Working Features
@@ -22,24 +22,24 @@ For detailed information about Polywrap and the WRAP standard, visit our [develo
> - Make sure you're running the correct version of python by running:
32
-
> ```
33
-
> python3 --version
34
-
> ```
30
+
### python ˆ3.10
31
+
- Make sure you're running the correct version of python by running:
32
+
```
33
+
python3 --version
34
+
```
35
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.
36
36
37
-
### `poetry ^1.1.14`
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
40
-
> ```
41
-
> brew install poetry
42
-
> ```
37
+
### poetry ^1.1.14
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
40
+
```
41
+
brew install poetry
42
+
```
43
43
> - To make sure you're it's installed properly, run `poetry`. Learn more [here](https://python-poetry.org/docs/)
44
44
45
45
@@ -84,7 +84,7 @@ poetry run pytest
84
84
85
85
This last command will run a series of scripts that verify that the specific module of the client is performing as expected in your local machine. The output on your console should look something like this:
86
86
87
-
```py
87
+
```
88
88
$ poetry run pytest
89
89
>>
90
90
================================= test session starts =================================
> 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:
101
-
> -`poetry run pytests -v` or `poetry run pytests -vv` for even more detail
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.
98
+
### Debugging with Pytest:
99
+
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:
101
+
-`poetry run pytests -v` or `poetry run pytests -vv` for even more detail
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.
103
103
104
104
105
105
## TOX
@@ -136,7 +136,7 @@ tox -e dev
136
136
- After running these commands we should see all the tests passing and commands executing successfully, which means that we are ready to update and test the package.
137
137
- To create your own tox scripts, modify the `tox.ini` file in the respective module.
138
138
139
-
## VSCode users: Improved venv experience
139
+
## VSCode users: Improved dev experience
140
140
If you use VSCode, we have prepared a pre-configured workspace that improves your dev experience. So when you open VScode, set up the workspace file `python-monorepo.code-workspace` by going to:
0 commit comments