Skip to main content

eth_abi: Python utilities for working with Ethereum ABI definitions, especially encoding and decoding

Project description

Ethereum Contract Interface (ABI) Utility

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

Python utilities for working with Ethereum ABI definitions, especially encoding and decoding

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

Quickstart

pip install eth_abi

Developer Setup

If you would like to hack on eth-abi, 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-abi.git
cd eth-abi
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_abi/ tests/ -c "clear; flake8 eth_abi 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-abi failed'" ../tests ../eth_abi

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_abi-3.0.1.tar.gz (484.6 kB view details)

Uploaded Source

Built Distribution

eth_abi-3.0.1-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

Details for the file eth_abi-3.0.1.tar.gz.

File metadata

  • Download URL: eth_abi-3.0.1.tar.gz
  • Upload date:
  • Size: 484.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for eth_abi-3.0.1.tar.gz
Algorithm Hash digest
SHA256 c3872e3ac1e9ef3f8c6599aaca4ee536d536eefca63a6892ab937f0560edb656
MD5 d53144d552bf41feae61980c40c16107
BLAKE2b-256 df949927d538a5e2af0c0ea3aa2ccc0ff1a0028a1245e32af24da5d8039b140b

See more details on using hashes here.

File details

Details for the file eth_abi-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: eth_abi-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for eth_abi-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 63d16f1f60870afc974cb0a3325fb275fa97822be1723b8878598df25eea8096
MD5 fbe4c8849f1901a366387f41fc4c893f
BLAKE2b-256 26d00776269e75d29bc448d5e84441443ecaa2417fab0565cf7a701e2acf24c8

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