mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
reorg test structure to match tox and CI jobs, drop bumpversion for bump-my-version and move config to pyproject.toml, fix docs building
This commit is contained in:
23
README.md
23
README.md
@ -26,28 +26,7 @@ Read more in the [documentation on ReadTheDocs](https://py-libp2p.readthedocs.io
|
||||
|
||||
Currently maintained by [@pacrob](https://github.com/pacrob) and [@dhuseby](https://github.com/dhuseby), looking for assistance!
|
||||
|
||||
Note that tests/test_libp2p/test_libp2p.py contains an end-to-end messaging test between two libp2p hosts, which is the bulk of our proof of concept.
|
||||
|
||||
### Dependencies
|
||||
|
||||
On Debian Linux you will need to ensure that you have the [GNU Multiprecision Arithmetic Library](https://gmplib.org/) installed since it is a dependency of the fastecdsa package. You can install it using the following command:
|
||||
|
||||
```sh
|
||||
sudo apt-get install libgmp-dev
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
Running `pytest` doesn't work with this project. The correct way to execute tests is to run `make test`.
|
||||
|
||||
### Release setup
|
||||
|
||||
Releases follow the same basic pattern as releases of some tangentially-related projects,
|
||||
like Trinity. See [Trinity's release instructions](https://trinity-client.readthedocs.io/en/latest/contributing.html#releasing).
|
||||
|
||||
## Requirements
|
||||
|
||||
The protobuf description in this repository was generated by `protoc` at version `25.3`.
|
||||
Note that tests/core/test_libp2p/test_libp2p.py contains an end-to-end messaging test between two libp2p hosts, which is the bulk of our proof of concept.
|
||||
|
||||
## Feature Breakdown
|
||||
|
||||
|
||||
Reference in New Issue
Block a user