py-evm


Namepy-evm JSON
Version 0.10.1b2 PyPI version JSON
download
home_pagehttps://github.com/ethereum/py-evm
SummaryPython implementation of the Ethereum Virtual Machine
upload_time2024-08-21 17:25:28
maintainerNone
docs_urlNone
authorEthereum Foundation
requires_python<4,>=3.8
licenseMIT
keywords ethereum blockchain evm
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Python Implementation of the Ethereum protocol

[![Join the conversation on Discord](https://img.shields.io/discord/809793915578089484?color=blue&label=chat&logo=discord&logoColor=white)](https://discord.gg/GHryRvPB84)
[![Build Status](https://circleci.com/gh/ethereum/py-evm.svg?style=shield)](https://circleci.com/gh/ethereum/py-evm)
[![PyPI version](https://badge.fury.io/py/py-evm.svg)](https://badge.fury.io/py/py-evm)
[![Python versions](https://img.shields.io/pypi/pyversions/py-evm.svg)](https://pypi.python.org/pypi/py-evm)
[![Docs build](https://readthedocs.org/projects/py-evm/badge/?version=latest)](https://py-evm.readthedocs.io/en/latest/?badge=latest)

## Py-EVM

Py-EVM is an implementation of the Ethereum protocol in Python. It contains the low level
primitives for the original proof-of-work (POW), (formerly known as Ethereum 1.0) chain
as well as emerging support for the proof-of-stake (POS) (formerly known as Ethereum 2.0) spec.

### Goals

Py-EVM aims to eventually become the defacto Python implementation of the Ethereum protocol,
enabling a wide array of use cases for both public and private chains.

In particular Py-EVM aims to:

- be a reference implementation of the Ethereum POW and POS implementations in one of the most widely used and understood languages, Python.

- be easy to understand and modifiable

- have clear and simple APIs

- come with solid, friendly documentation

- deliver the low level primitives to build various clients on top (including *full* and *light* clients)

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

## Quickstart

```sh
python -m pip install py-evm
```

[Get started in 5 minutes](https://py-evm.readthedocs.io/en/latest/guides/building_an_app_that_uses_pyevm.html)

## Documentation

Check out the [documentation on our official website](https://py-evm.readthedocs.io/en/latest/)

## Developer Setup

If you would like to hack on py-evm, please check out the [Snake Charmers
Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)
for information on how we do:

- Testing
- Pull Requests
- Documentation

We use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once
installed, it will run automatically with every commit. You can also run it manually
with `make lint`. If you need to make a commit that skips the `pre-commit` checks, you
can do so with `git commit --no-verify`.

### Development Environment Setup

```sh
git clone git@github.com:ethereum/py-evm.git
cd py-evm
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install
```

### Release setup

To release a new version:

```sh
make release bump=$$VERSION_PART_TO_BUMP$$
```

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
main branch, except when releasing a beta (in which case the beta is released from main,
and the previous stable branch is released from said branch).

## Want to help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our
guidelines for [contributing](https://py-evm.readthedocs.io/en/latest/contributing.html) and then check out one of our issues that are labeled [Good First Issue](https://github.com/ethereum/py-evm/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+First+Issue%22).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ethereum/py-evm",
    "name": "py-evm",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4,>=3.8",
    "maintainer_email": null,
    "keywords": "ethereum blockchain evm",
    "author": "Ethereum Foundation",
    "author_email": "snakecharmers@ethereum.org",
    "download_url": "https://files.pythonhosted.org/packages/c4/56/f90ebb53e121d5e1dea0eff713dd0434d2ea938431311e6d8e99fdbb8a8d/py_evm-0.10.1b2.tar.gz",
    "platform": null,
    "description": "# Python Implementation of the Ethereum protocol\n\n[![Join the conversation on Discord](https://img.shields.io/discord/809793915578089484?color=blue&label=chat&logo=discord&logoColor=white)](https://discord.gg/GHryRvPB84)\n[![Build Status](https://circleci.com/gh/ethereum/py-evm.svg?style=shield)](https://circleci.com/gh/ethereum/py-evm)\n[![PyPI version](https://badge.fury.io/py/py-evm.svg)](https://badge.fury.io/py/py-evm)\n[![Python versions](https://img.shields.io/pypi/pyversions/py-evm.svg)](https://pypi.python.org/pypi/py-evm)\n[![Docs build](https://readthedocs.org/projects/py-evm/badge/?version=latest)](https://py-evm.readthedocs.io/en/latest/?badge=latest)\n\n## Py-EVM\n\nPy-EVM is an implementation of the Ethereum protocol in Python. It contains the low level\nprimitives for the original proof-of-work (POW), (formerly known as Ethereum 1.0) chain\nas well as emerging support for the proof-of-stake (POS) (formerly known as Ethereum 2.0) spec.\n\n### Goals\n\nPy-EVM aims to eventually become the defacto Python implementation of the Ethereum protocol,\nenabling a wide array of use cases for both public and private chains.\n\nIn particular Py-EVM aims to:\n\n- be a reference implementation of the Ethereum POW and POS implementations in one of the most widely used and understood languages, Python.\n\n- be easy to understand and modifiable\n\n- have clear and simple APIs\n\n- come with solid, friendly documentation\n\n- deliver the low level primitives to build various clients on top (including *full* and *light* clients)\n\n- be highly flexible to support both research as well as alternate use cases like private chains.\n\n## Quickstart\n\n```sh\npython -m pip install py-evm\n```\n\n[Get started in 5 minutes](https://py-evm.readthedocs.io/en/latest/guides/building_an_app_that_uses_pyevm.html)\n\n## Documentation\n\nCheck out the [documentation on our official website](https://py-evm.readthedocs.io/en/latest/)\n\n## Developer Setup\n\nIf you would like to hack on py-evm, please check out the [Snake Charmers\nTactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)\nfor information on how we do:\n\n- Testing\n- Pull Requests\n- Documentation\n\nWe use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once\ninstalled, it will run automatically with every commit. You can also run it manually\nwith `make lint`. If you need to make a commit that skips the `pre-commit` checks, you\ncan do so with `git commit --no-verify`.\n\n### Development Environment Setup\n\n```sh\ngit clone git@github.com:ethereum/py-evm.git\ncd py-evm\nvirtualenv -p python3 venv\n. venv/bin/activate\npython -m pip install -e \".[dev]\"\npre-commit install\n```\n\n### Release setup\n\nTo release a new version:\n\n```sh\nmake release bump=$$VERSION_PART_TO_BUMP$$\n```\n\nTo issue the next version in line, specify which part to bump,\nlike `make release bump=minor` or `make release bump=devnum`. This is typically done from the\nmain branch, except when releasing a beta (in which case the beta is released from main,\nand the previous stable branch is released from said branch).\n\n## Want to help?\n\nWant to file a bug, contribute some code, or improve documentation? Excellent! Read up on our\nguidelines for [contributing](https://py-evm.readthedocs.io/en/latest/contributing.html) and then check out one of our issues that are labeled [Good First Issue](https://github.com/ethereum/py-evm/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+First+Issue%22).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python implementation of the Ethereum Virtual Machine",
    "version": "0.10.1b2",
    "project_urls": {
        "Homepage": "https://github.com/ethereum/py-evm"
    },
    "split_keywords": [
        "ethereum",
        "blockchain",
        "evm"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "86c59f3e66a43083a715055f0503d283dca7186f4253754b474f5804304ef297",
                "md5": "d1d91064f885f6c4de7c84cdc3f3e2f0",
                "sha256": "511bd52c9c08837ae2a02cce923a756e85330dc14cc6abb15986ea99dc2832ac"
            },
            "downloads": -1,
            "filename": "py_evm-0.10.1b2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d1d91064f885f6c4de7c84cdc3f3e2f0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.8",
            "size": 778907,
            "upload_time": "2024-08-21T17:25:26",
            "upload_time_iso_8601": "2024-08-21T17:25:26.187921Z",
            "url": "https://files.pythonhosted.org/packages/86/c5/9f3e66a43083a715055f0503d283dca7186f4253754b474f5804304ef297/py_evm-0.10.1b2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c456f90ebb53e121d5e1dea0eff713dd0434d2ea938431311e6d8e99fdbb8a8d",
                "md5": "0c1fde11b2519e9e96297530c49b7d42",
                "sha256": "7a06fbd1d966eb0cd4f6c6d9e7fe1e2c43473804ac12b12325b0a31cbab5670f"
            },
            "downloads": -1,
            "filename": "py_evm-0.10.1b2.tar.gz",
            "has_sig": false,
            "md5_digest": "0c1fde11b2519e9e96297530c49b7d42",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.8",
            "size": 836114,
            "upload_time": "2024-08-21T17:25:28",
            "upload_time_iso_8601": "2024-08-21T17:25:28.075443Z",
            "url": "https://files.pythonhosted.org/packages/c4/56/f90ebb53e121d5e1dea0eff713dd0434d2ea938431311e6d8e99fdbb8a8d/py_evm-0.10.1b2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-21 17:25:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ethereum",
    "github_project": "py-evm",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "circle": true,
    "tox": true,
    "lcname": "py-evm"
}
        
Elapsed time: 0.34602s