Skip to content
A python interface for interacting with the Ethereum blockchain and ecosystem.
Python Other
  1. Python 99.9%
  2. Other 0.1%
Branch: master
Clone or download
njgheorghita Merge pull request #1428 from njgheorghita/update-tx-timeout-error-msg
Display hexstr not bytes tx hash on tx timeout
Latest commit 9ec8556 Aug 22, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Remove infura_env fixture, and use pytests skipif to detect env var Jul 12, 2019
.github Add pip freeze output to template. Oct 11, 2018
docs Mostly whitespace, and removed an 's' from topic in the geth docs Aug 22, 2019
ens Remove IDNA processing in favor of UTS46 Jul 11, 2019
ethpm Merge pull request #1418 from njgheorghita/ethpm-fix-regex Aug 12, 2019
tests Merge pull request #1418 from njgheorghita/ethpm-fix-regex Aug 12, 2019
web3 Merge pull request #1428 from njgheorghita/update-tx-timeout-error-msg Aug 22, 2019
.bumpversion.cfg Bump version: 5.0.1 → 5.0.2 Aug 22, 2019
.gitignore Remove .DS_Store files Jan 17, 2019
.readthedocs.yml Change readthedocs yaml to build from latest image Dec 13, 2018 Add Apr 21, 2016 change to new dependency names and update repo uri Nov 29, 2017
Dockerfile Add ethpm to dockerfile Jul 31, 2019
LICENSE initial commit Apr 14, 2016 Include ethpm assets in sdist via Jul 16, 2019
Makefile Move ethpm documentation over to web3 docs Jul 10, 2019 Remove doctest dependency on ethtoken (#1395) Jul 26, 2019 Add error if no Infura key is found Mar 25, 2019
docker-compose.yml Update parity version to 2.3.5 for integration tests Mar 21, 2019
pytest.ini Use pytest instead of py.test per upstream recommendation, #dropthedot May 15, 2018
requirements-docs.txt Fix docs build Oct 2, 2018 Bump version: 5.0.1 → 5.0.2 Aug 22, 2019
tox.ini Remove doctest dependency on ethtoken (#1395) Jul 26, 2019

Join the chat at

Build Status

A Python implementation of web3.js

  • Python 3.6+ support

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

Developer Setup

git clone

Please see OS-specific instructions for:

Then run these install commands:

virtualenv venv
. venv/bin/activate
pip install -e .[dev]

For different environments, you can set up multiple virtualenv. For example, if you want to create a venvdocs, then you do the following:

virtualenv venvdocs
. venvdocs/bin/activate
pip install -e .[docs]
pip install -e .

Using Docker

If you would like to develop and test inside a Docker environment, use the sandbox container provided in the docker-compose.yml file.

To start up the test environment, run:

docker-compose up -d

This will build a Docker container set up with an environment to run the Python test code.

Note: This container does not have go-ethereum installed, so you cannot run the go-ethereum test suite.

To run the Python tests from your local machine:

docker-compose exec sandbox bash -c 'pytest -n 4 -f -k "not goethereum"'

You can run arbitrary commands inside the Docker container by using the bash -c prefix.

docker-compose exec sandbox bash -c ''

Or, if you would like to just open a session to the container, run:

docker-compose exec sandbox bash

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 web3/ tests/ ens/ -c "clear; flake8 web3 tests ens && echo 'flake8 success' || echo 'error'"

You can use pytest-watch, running one for every Python environment:

pip install pytest-watch

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

Or, you can 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

How to Execute the Tests?

  1. Setup your development environment.

  2. Execute tox for the tests

There are multiple components of the tests. You can run test to against specific component. For example:

# Run Tests for the Core component (for Python 3.6):
tox -e py36-core

# Run Tests for the Core component (for Python 3.7):
tox -e py37-core

If for some reason it is not working, add --recreate params.

tox is good for testing against the full set of build targets. But if you want to run the tests individually, py.test is better for development workflow. For example, to run only the tests in one file:

py.test tests/core/gas-strategies/

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.

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"

You can’t perform that action at this time.