Common utility functions for ethereum codebases.
Project description
# Ethereum Utils [![Join the chat at https://gitter.im/ethereum/eth-utils](https://badges.gitter.im/ethereum/eth-utils.svg)](https://gitter.im/ethereum/eth-utils)
[![Build Status](https://circleci.com/gh/ethereum/eth-utils.svg?style=shield)](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”
Project details
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
Hashes for eth_utils-1.9.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a2b59dcb9de40f2e793633be15d581fcb6b22c2dc81918698f01521c7b4c055 |
|
MD5 | a891bed2c5af0732ed6a6325ea6fd54d |
|
BLAKE2b-256 | d10aeea4bbc8453e7dc6722a57167ab1974179a29734063ca40d81075451d13c |