Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Python Implementation of the EVM

Join the chat at https://gitter.im/ethereum/py-evm Documentation Status

Documentation hosted by ReadTheDocs

Introducing Py-EVM

Py-EVM is a new implementation of the Ethereum Virtual Machine written in python. It is currently in active development but is quickly progressing through the test suite provided by ethereum/tests. We have Vitalik, and the existing PyEthereum code to thank for the quick progress we’ve made as many design decisions were inspired, or even directly ported from the PyEthereum codebase.

Goals

Py-EVM aims to eventually become the defacto Python implementation of the EVM, enabling a wide array of use cases for both public and private chains. Development will focus on creating an EVM with a well defined API, friendly and easy to digest documentation which can be run as a fully functional mainnet node.

In particular Py-EVM aims to:

  • be an example implementation of the EVM in one of the most widely used and understood languages, Python.

  • deliver the low level APIs for clients to build full or light nodes on top of

  • be easy to understand and modifiable

  • be highly flexible to support both research as well as alternate use cases like private chains.

Trinity

While Py-EVM provides the low level APIs of the EVM, it does not aim to implement a full or light node directly.

We provide a base implementation of a full node called Trinity that is based on Py-EVM.

In the future there may be alternative clients based on the Py-EVM.

Step 1: Alpha Release

The plan is to begin with an MVP, alpha-level release that is suitable for testing purposes. We’ll be looking for early adopters to provide feedback on our architecture and API choices as well as general feedback and bug finding.

Blog posts:

Development

Py-EVM depends on a submodule of the common tests across all clients, so you need to clone the repo with the --recursive flag. Example:

git clone --recursive git@github.com:ethereum/py-evm.git

Py-EVM requires Python 3. Often, the best way to guarantee a clean Python 3 environment is with `virtualenv <https://virtualenv.pypa.io/en/stable/>`__, like:

# once:
$ virtualenv -p python3 venv

# each session:
$ . venv/bin/activate

Then install the required python packages via:

pip install -e .[dev]

Running the tests

You can run the tests with:

pytest

Or you can install tox to run the full test suite.

Releasing

Pandoc is required for transforming the markdown README to the proper format to render correctly on pypi.

For Debian-like systems:

apt install pandoc

Or on OSX:

brew install pandoc

To release a new version:

bumpversion $$VERSION_PART_TO_BUMP$$
git push && git push --tags
make release

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, use bumpversion and specify which part to bump, like bumpversion minor or bumpversion devnum.

If you are in a beta version, bumpversion stage will switch to a stable.

To issue an unstable version when the current version is stable, specify the new version explicitly, like bumpversion --new-version 4.0.0-alpha.1 devnum

Metadata

Release files for py-evm 0.2.0a31

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-evm 0.2.0a31
File Size Uploaded
py-evm-0.2.0a31.tar.gz 221.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for py-evm 0.2.0a31
File Interpreter ABI Platform
py_evm-0.2.0a31-py3-none-any.whl Python 3 none any Details

Total release size: 532.7 kB

Release files / py-evm-0.2.0a31.tar.gz

Download URL py-evm-0.2.0a31.tar.gz
Size 221.7 kB
Tags Source
SHA-256 checksum
How to use checksums
045859e98d8363c534a7b85abed462222bd1ddeb1730ba752f26211ea3fae858
BLAKE2b-256 checksum
How to use checksums
465fd47f11d1b364e3aecbcc8df191d7098b7167ea53fbfb97d8297f57ba67c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

Release files / py_evm-0.2.0a31-py3-none-any.whl

Download URL py_evm-0.2.0a31-py3-none-any.whl
Size 311.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6c793ef05b8e838d9cf677bd0f8f5bd2121c5ab7180fbe06f1416e6f62c45b3
BLAKE2b-256 checksum
How to use checksums
4c55ef4dd26973f0198bc8c6472999e51f56fc6943114975958a30a9e1153a9b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

Release history Release notifications | RSS feed

This release

0.2.0a31 This release

2 release 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