Skip to main content

eth-utils: Common utility functions for python code that interacts with Ethereum

Project description

Ethereum Utilities

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

Common utility functions for python code that interacts with Ethereum

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

Quickstart

pip install eth-utils

Developer Setup

If you would like to hack on eth-utils, 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-utils.git
cd eth-utils
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]
pip install -e eth-hash[pycryptodome]

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_utils/ tests/ -c "clear; flake8 eth_utils 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-utils failed'" ../tests ../eth_utils

Release setup

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-utils-1.10.0.tar.gz (4.6 MB view details)

Uploaded Source

Built Distribution

eth_utils-1.10.0-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

Details for the file eth-utils-1.10.0.tar.gz.

File metadata

  • Download URL: eth-utils-1.10.0.tar.gz
  • Upload date:
  • Size: 4.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5

File hashes

Hashes for eth-utils-1.10.0.tar.gz
Algorithm Hash digest
SHA256 bf82762a46978714190b0370265a7148c954d3f0adaa31c6f085ea375e4c61af
MD5 4e785e1f5a12561fcf853c35183be10c
BLAKE2b-256 deb1fcae902be069ea771af755839b677d196ac0959bf93b6418f12e45212b5e

See more details on using hashes here.

File details

Details for the file eth_utils-1.10.0-py3-none-any.whl.

File metadata

  • Download URL: eth_utils-1.10.0-py3-none-any.whl
  • Upload date:
  • Size: 24.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5

File hashes

Hashes for eth_utils-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 74240a8c6f652d085ed3c85f5f1654203d2f10ff9062f83b3bad0a12ff321c7a
MD5 be8e240ad3748632839345c424850045
BLAKE2b-256 997178170b0fdeb7ee6aa24c2206ac2d0d4f097ff0d9ad4ab4f748e04ea73187

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