Skip to main content

libp2p: Python implementation of the libp2p networking protocol

Project description

Join the chat at https://gitter.im/ethereum/py-libp2p Build Status PyPI version Python versions Docs build

Python implementation of the libp2p networking protocol

Read more in the documentation on ReadTheDocs. View the change log.

Quickstart

pip install libp2p

Developer Setup

If you would like to hack on py-libp2p, please check out the Ethereum Development Tactical Manual for information on how we do:

  • Testing

  • Pull Requests

  • Code Style

  • Documentation

Development Environment Setup

You can set up your dev environment with:

git clone git@github.com:ethereum/py-libp2p.git
cd py-libp2p
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]

Testing Setup

During development, you might like to have tests run on every file save.

Show flake8 errors on file change:

# Test flake8
when-changed -v -s -r -1 libp2p/ tests/ -c "clear; flake8 libp2p tests && echo 'flake8 success' || echo 'error'"

Run multi-process tests in one command, but without color:

# in the project root:
pytest --numprocesses=4 --looponfail --maxfail=1
# the same thing, succinctly:
pytest -n 4 -f --maxfail=1

Run in one thread, with color and desktop notifications:

cd venv
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on py-libp2p failed'" ../tests ../libp2p

Release setup

For Debian-like systems:

apt install pandoc

To release a new version:

make release bump=$$VERSION_PART_TO_BUMP$$

How to bumpversion

The version format for this repo is {major}.{minor}.{patch} for stable, and {major}.{minor}.{patch}-{stage}.{devnum} for unstable (stage can be alpha or beta).

To issue the next version in line, specify which part to bump, like make release bump=minor or make release bump=devnum. This is typically done from the master branch, except when releasing a beta (in which case the beta is released from master, and the previous stable branch is released from said branch). To include changes made with each release, update “docs/releases.rst” with the changes, and apply commit directly to master before release.

If you are in a beta version, make release bump=stage will switch to a stable.

To issue an unstable version when the current version is stable, specify the new version explicitly, like make release bump="--new-version 4.0.0-alpha.1 devnum"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

libp2p-0.1.0a0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

libp2p-0.1.0a0-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file libp2p-0.1.0a0.tar.gz.

File metadata

  • Download URL: libp2p-0.1.0a0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.5

File hashes

Hashes for libp2p-0.1.0a0.tar.gz
Algorithm Hash digest
SHA256 e34b84a3e6239f57ccfd26f96d06a3d990dfadfd067c948e814cecb4756fbb5d
MD5 c1c2bacd4b466ba790ac20630b94c047
BLAKE2b-256 c70c36f26d5129fc973986cc83fc436a107858abccf0a833f51a65cd2442c0cc

See more details on using hashes here.

File details

Details for the file libp2p-0.1.0a0-py3-none-any.whl.

File metadata

  • Download URL: libp2p-0.1.0a0-py3-none-any.whl
  • Upload date:
  • Size: 3.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.5

File hashes

Hashes for libp2p-0.1.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 356310846f95b9c2dbca7e6bb428d26c428b5bc49313415435fc401c50fc85f9
MD5 919c1bb5bcea0581bd0e1ec64b10c014
BLAKE2b-256 264aba42fd91ce2f01e7f6ca11e773c768a575fb6d38cb6dde1383fed4373b0c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page