Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethereum/eth-utils
Utility functions for working with ethereum related codebases.
https://github.com/ethereum/eth-utils
ethereum python utility-library
Last synced: 29 days ago
JSON representation
Utility functions for working with ethereum related codebases.
- Host: GitHub
- URL: https://github.com/ethereum/eth-utils
- Owner: ethereum
- License: mit
- Created: 2017-02-07T15:15:18.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T17:13:34.000Z (about 2 months ago)
- Last Synced: 2024-09-29T16:20:57.583Z (about 1 month ago)
- Topics: ethereum, python, utility-library
- Language: Python
- Homepage: https://eth-utils.readthedocs.io/en/latest/
- Size: 855 KB
- Stars: 314
- Watchers: 20
- Forks: 152
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: newsfragments/284.bugfix.rst
- Contributing: docs/contributing.rst
- License: LICENSE
- Code of conduct: docs/code_of_conduct.rst
Awesome Lists containing this project
- best-of-crypto - GitHub - 25% open · ⏱️ 06.05.2024): (Smart Contract Platforms)
README
# 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 [email protected]: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"`