py-libp2p/README.md
2018-11-12 13:32:55 -05:00

26 lines
695 B
Markdown

# py-libp2p
<h1 align="center">
<img width="250" align="center" src="https://github.com/zixuanzh/py-libp2p/blob/master/assets/py-libp2p-logo.png?raw=true" alt="py-libp2p hex logo" />
</h1>
## Development
py-libp2p requires Python 3.6 and the best way to guarantee a clean Python 3.6 environment is with [`virtualenv`](https://virtualenv.pypa.io/en/stable/)
```sh
virtualenv -p python3.6 venv
. venv/bin/activate
pip install -r requirements.txt
```
## Testing
After installing our requirements (see above), you can:
```sh
cd tests
pytest
```
Note that tests/libp2p/test_libp2p.py contains an end-to-end messaging test between two libp2p hosts, which is the bulk of our proof of compass.