eth-utils: Common utility functions for python code that interacts with Ethereum
Project description
Ethereum Utilities
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size eth_utils-1.10.0-py3-none-any.whl (24.3 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size eth-utils-1.10.0.tar.gz (4.6 MB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for eth_utils-1.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74240a8c6f652d085ed3c85f5f1654203d2f10ff9062f83b3bad0a12ff321c7a |
|
MD5 | be8e240ad3748632839345c424850045 |
|
BLAKE2-256 | 997178170b0fdeb7ee6aa24c2206ac2d0d4f097ff0d9ad4ab4f748e04ea73187 |