Skip to content

Commit aaa4bbf

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

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Polywrap Python Client
44

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.
66

77

88
# Working Features
@@ -22,24 +22,24 @@ For detailed information about Polywrap and the WRAP standard, visit our [develo
2222

2323
## Pre-requisites
2424

25-
### `Clone the repo.`
26-
>```
27-
>git clone https://github.com/polywrap/python-client
28-
>```
25+
### Clone the repo.
26+
```
27+
git clone https://github.com/polywrap/python-client
28+
```
2929

30-
### `python ˆ3.10`
31-
> - 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+
```
3535
> - 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.
3636
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+
```
4343
> - To make sure you're it's installed properly, run `poetry`. Learn more [here](https://python-poetry.org/docs/)
4444
4545

@@ -84,7 +84,7 @@ poetry run pytest
8484

8585
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:
8686

87-
```py
87+
```
8888
$ poetry run pytest
8989
>>
9090
================================= test session starts =================================
@@ -95,11 +95,11 @@ collected 26 items
9595
tests/test_msgpack.py ........................ [100%]
9696
```
9797

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.
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.
103103

104104

105105
## TOX
@@ -136,7 +136,7 @@ tox -e dev
136136
- 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.
137137
- To create your own tox scripts, modify the `tox.ini` file in the respective module.
138138

139-
## VSCode users: Improved venv experience
139+
## VSCode users: Improved dev experience
140140
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:
141141

142142
```

0 commit comments

Comments
 (0)