Common utility functions for ethereum codebases.
Project description
# Ethereum Utils [](https://gitter.im/ethereum/eth-utils)
[](https://circleci.com/gh/ethereum/eth-utils)
[Documentation hosted by ReadTheDocs](https://eth-utils.readthedocs.io/en/latest/)
Common utility functions for codebases which interact with ethereum.
> This library and repository was previously located at https://github.com/pipermerriam/ethereum-utils. It was transferred to the Ethereum foundation github in November 2017 and renamed to eth-utils. The PyPi package was also renamed from ethereum-utils to eth-utils.
## Installation
`sh pip install eth-utils `
## Development
Clone the repository and then run:
`sh pip install -e .[dev] eth-hash[pycryptodome] `
## Documentation
Building Sphinx docs locally:
`sh pip install -e .[doc] cd docs make html `
Docs are written in [reStructuredText](http://docutils.sourceforge.net/rst.html) and built using the [Sphinx](http://www.sphinx-doc.org/) documentation generator.
### Running the tests
You can run the tests with:
`sh py.test tests `
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:
`sh brew install pandoc `
To release a new version:
`sh make release bump=$$VERSION_PART_TO_BUMP$$ ` To preview the upcoming release notes:
`sh towncrier --draft `
#### 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”
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file eth-utils-1.9.2.tar.gz.
File metadata
- Download URL: eth-utils-1.9.2.tar.gz
- Upload date:
- Size: 19.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5f4e32ed2fd8c136ae2ba077f1c79d7790c0ffeb52ebd3fcee8ff623eb353f86 |
|
| MD5 | 55c7d70958b18159024f427371030976 |
|
| BLAKE2b-256 | 80054a30da45288f8d89fdbf501e16f49d9ee904f769c057a3209fce358e8397 |
File details
Details for the file eth_utils-1.9.2-py3-none-any.whl.
File metadata
- Download URL: eth_utils-1.9.2-py3-none-any.whl
- Upload date:
- Size: 23.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2a2b59dcb9de40f2e793633be15d581fcb6b22c2dc81918698f01521c7b4c055 |
|
| MD5 | a891bed2c5af0732ed6a6325ea6fd54d |
|
| BLAKE2b-256 | d10aeea4bbc8453e7dc6722a57167ab1974179a29734063ca40d81075451d13c |
](https://gitter.im/ethereum/eth-utils](https://gitter.im/ethereum/eth-utils](https://badges.gitter.im/ethereum/eth-utils.svg)](https://gitter.im/ethereum/eth-utils){kind=link}
](https://circleci.com/gh/ethereum/eth-utils){kind=link}