-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added "Contributing / Building From Source"
- Loading branch information
taras
committed
Sep 13, 2024
1 parent
15db04b
commit c6aea0c
Showing
2 changed files
with
49 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,6 +32,12 @@ Use pip to install it:: | |
|
||
$ pip install picows | ||
|
||
|
||
Documentation | ||
============= | ||
|
||
https://picows.readthedocs.io/en/stable/ | ||
|
||
Rationale | ||
========= | ||
Popular WebSocket libraries attempt to provide high-level interfaces. They take care of timeouts, flow control, optional compression/decompression, assembling WebSocket messages from frames, as well as implementing async iteration interfaces. | ||
|
@@ -131,7 +137,45 @@ Features | |
* Ability to check if a frame is the last one in the receiving buffer | ||
* Support both secure and unsecure protocols (ws and wss schemes) | ||
|
||
Documentation | ||
============= | ||
Contributing / Building From Source | ||
=================================== | ||
1. Fork and clone the repository:: | ||
|
||
$ git clone [email protected]:tarasko/picows.git | ||
$ cd picows | ||
|
||
2. Create a virtual environment and activate it:: | ||
|
||
$ python3 -m venv picows-dev | ||
$ source picows-dev/bin/activate | ||
|
||
|
||
3. Install development dependencies:: | ||
|
||
# To run tests | ||
$ pip install -r requirements-test.txt | ||
|
||
# To run benchmark | ||
$ pip install -r requirements-benchmark.txt | ||
|
||
# To build docs | ||
$ pip install -r docs/requirements.txt | ||
|
||
4. Build inplace and run tests:: | ||
|
||
$ export PICOWS_BUILD_EXAMPLES=1 | ||
$ python setup.py build_ext --inplace | ||
$ pytest -s -v | ||
|
||
# Run specific test | ||
$ pytest -s -v -k test_client_handshake_timeout[uvloop-plain] | ||
|
||
5. Run benchmark:: | ||
|
||
$ python -m examples.echo_server | ||
$ python -m examples.echo_client | ||
|
||
6. Build docs:: | ||
|
||
$ make -C docs clean html | ||
|
||
https://picows.readthedocs.io/en/stable/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
websockets | ||
aiohttp | ||
numpy | ||
matplotlib | ||
uvloop; sys_platform != 'win32' |