Skip to main content

eth-portal: A collection of utilities related to Ethereum's Portal Network

Project description

Portal Network Tools

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

A collection of utilities related to Ethereum's Portal Network

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

Quickstart

pip install eth-portal

Developer Setup

If you would like to hack on eth-portal, please check out the Snake Charmers 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/eth-portal.git
cd eth-portal
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 eth_portal/ tests/ -c "clear; flake8 eth_portal 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 eth-portal failed'" ../tests ../eth_portal

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

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

eth-portal-0.2.0.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

eth_portal-0.2.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file eth-portal-0.2.0.tar.gz.

File metadata

  • Download URL: eth-portal-0.2.0.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.10

File hashes

Hashes for eth-portal-0.2.0.tar.gz
Algorithm Hash digest
SHA256 36a4b4113444e3201a9eb18429486306fac4bcdf10fe2a1682624d23c1c5d061
MD5 358a907a73d2acb4a05e7474a0ecb1e7
BLAKE2b-256 c6601fb5f0bf6dd101ea4b924190c4c959757a206efd89d715acda233120b333

See more details on using hashes here.

File details

Details for the file eth_portal-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: eth_portal-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.10

File hashes

Hashes for eth_portal-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b5273e3724ebba83aba4c842f0b961f878cac3b6ba459921ba21502ba84d0f1
MD5 69e3256e3431a210019571eb056f7158
BLAKE2b-256 8a98ca6b1528de2c5606dfad0d4df95b6c53f005fff563fb3c87ef6378dd9aeb

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