Skip to main content

A Python implementation of NewChain Web3 which is forked from https://github.com/ethereum/web3.py.

  • Python 3.6+ support

Developer Setup

git clone git@github.com:xiawu/newchain-web3.py.git
cd newchain-web3.py

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 web3.py 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.5):
tox -e py35-core

# Run Tests for the Core component (for Python 3.6):
tox -e py36-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/test_time_based_gas_price_strategy.py

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"

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

newchain-web3-0.1.0.tar.gz (110.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

newchain_web3-0.1.0-py3-none-any.whl (140.9 kB view details)

Uploaded Python 3

File details

Details for the file newchain-web3-0.1.0.tar.gz.

File metadata

  • Download URL: newchain-web3-0.1.0.tar.gz
  • Upload date:
  • Size: 110.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.2

File hashes

Hashes for newchain-web3-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bc0b21d8bea5afd57490b939c531cb15a77e4cad9a2cf758d1bc43a3630936bc
MD5 7deb1fa24af5e88ebe60af98ce96a428
BLAKE2b-256 a643216812281d79333be439b1eb86d20b9ff64a30f5bcea21a13784215ca029

See more details on using hashes here.

File details

Details for the file newchain_web3-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: newchain_web3-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 140.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.2

File hashes

Hashes for newchain_web3-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d8860e96618558fda064196d9c49fed1fc0dd947d488eabd49ebed191b3b90a7
MD5 d7dac3f6f4f0d0596ab3b7e974fee02b
BLAKE2b-256 72be6e1c786af9533f3030f6c844b09bed867b27d3fccc636a3238f0fd7c1741

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

This release

0.1.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page