# Ethereum Utilities
[](https://discord.gg/GHryRvPB84)
[](https://circleci.com/gh/ethereum/eth-utils)
[](https://badge.fury.io/py/eth-utils)
[](https://pypi.python.org/pypi/eth-utils)
[](https://eth-utils.readthedocs.io/en/latest/?badge=latest)
Common utility functions for python code that interacts with Ethereum
Read the [documentation](https://eth-utils.readthedocs.io/).
View the [change log](https://eth-utils.readthedocs.io/en/latest/release_notes.html).
## Installation
```sh
python -m pip install eth-utils
```
## Developer Setup
If you would like to hack on eth-utils, 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
You can set up your dev environment with:
```sh
git clone git@github.com:ethereum/eth-utils.git
cd eth-utils
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install
```
### Update Networks
The list of networks resides in the JSON file under eth_utils/\_\_json/eth_networks.json.
This file is used to initialize Networks, which can be used to obtain network
information with a chain ID.
Run the script to update the JSON file with the response from the remote list.
```sh
python update_networks.py
```
If there are new networks they will appear in the JSON file. After checking the updates,
open a PR to make them available in a new release.
### Release setup
To release a new version:
```sh
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
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).
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"`
Raw data
{
"_id": null,
"home_page": "https://github.com/ethereum/eth-utils",
"name": "eth-utils",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "ethereum",
"author": "The Ethereum Foundation",
"author_email": "snakecharmers@ethereum.org",
"download_url": "https://files.pythonhosted.org/packages/cc/b2/d5180e5dd01c5f5c9178274c7e27c67579c67554045370d3b8e60b562ea8/eth_utils-5.1.0.tar.gz",
"platform": null,
"description": "# Ethereum Utilities\n\n[](https://discord.gg/GHryRvPB84)\n[](https://circleci.com/gh/ethereum/eth-utils)\n[](https://badge.fury.io/py/eth-utils)\n[](https://pypi.python.org/pypi/eth-utils)\n[](https://eth-utils.readthedocs.io/en/latest/?badge=latest)\n\nCommon utility functions for python code that interacts with Ethereum\n\nRead the [documentation](https://eth-utils.readthedocs.io/).\n\nView the [change log](https://eth-utils.readthedocs.io/en/latest/release_notes.html).\n\n## Installation\n\n```sh\npython -m pip install eth-utils\n```\n\n## Developer Setup\n\nIf you would like to hack on eth-utils, 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\nYou can set up your dev environment with:\n\n```sh\ngit clone git@github.com:ethereum/eth-utils.git\ncd eth-utils\nvirtualenv -p python3 venv\n. venv/bin/activate\npython -m pip install -e \".[dev]\"\npre-commit install\n```\n\n### Update Networks\n\nThe list of networks resides in the JSON file under eth_utils/\\_\\_json/eth_networks.json.\nThis file is used to initialize Networks, which can be used to obtain network\ninformation with a chain ID.\n\nRun the script to update the JSON file with the response from the remote list.\n\n```sh\npython update_networks.py\n```\n\nIf there are new networks they will appear in the JSON file. After checking the updates,\nopen a PR to make them available in a new release.\n\n### Release setup\n\nTo release a new version:\n\n```sh\nmake release bump=$$VERSION_PART_TO_BUMP$$\n```\n\n#### How to bumpversion\n\nThe version format for this repo is `{major}.{minor}.{patch}` for stable, and\n`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).\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\nIf you are in a beta version, `make release bump=stage` will switch to a stable.\n\nTo issue an unstable version when the current version is stable, specify the\nnew version explicitly, like `make release bump=\"--new-version 4.0.0-alpha.1 devnum\"`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "eth-utils: Common utility functions for python code that interacts with Ethereum",
"version": "5.1.0",
"project_urls": {
"Homepage": "https://github.com/ethereum/eth-utils"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7c19e8d3e0e53dea8fb3054892e536cd1e02ebf492eeb4c42901763c2ae67f44",
"md5": "27bae028d8a68c2ecf377d408083cb08",
"sha256": "a99f1f01b51206620904c5af47fac65abc143aebd0a76bdec860381c5a3230f8"
},
"downloads": -1,
"filename": "eth_utils-5.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "27bae028d8a68c2ecf377d408083cb08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 100513,
"upload_time": "2024-10-21T19:23:11",
"upload_time_iso_8601": "2024-10-21T19:23:11.731658Z",
"url": "https://files.pythonhosted.org/packages/7c/19/e8d3e0e53dea8fb3054892e536cd1e02ebf492eeb4c42901763c2ae67f44/eth_utils-5.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ccb2d5180e5dd01c5f5c9178274c7e27c67579c67554045370d3b8e60b562ea8",
"md5": "926de50234f95659cafe5e05d99a8c09",
"sha256": "84c6314b9cf1fcd526107464bbf487e3f87097a2e753360d5ed319f7d42e3f20"
},
"downloads": -1,
"filename": "eth_utils-5.1.0.tar.gz",
"has_sig": false,
"md5_digest": "926de50234f95659cafe5e05d99a8c09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 120325,
"upload_time": "2024-10-21T19:23:13",
"upload_time_iso_8601": "2024-10-21T19:23:13.790032Z",
"url": "https://files.pythonhosted.org/packages/cc/b2/d5180e5dd01c5f5c9178274c7e27c67579c67554045370d3b8e60b562ea8/eth_utils-5.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 19:23:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethereum",
"github_project": "eth-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "eth-utils"
}
JSON
