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$$
```
#### 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"`
[](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$$
```
#### 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
eth-utils-1.3.0.tar.gz
(12.7 kB
view details)
Built Distribution
eth_utils-1.3.0-py3-none-any.whl
(17.6 kB
view details)
File details
Details for the file eth-utils-1.3.0.tar.gz.
File metadata
- Download URL: eth-utils-1.3.0.tar.gz
- Upload date:
- Size: 12.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 624052ace73253766c39e2197a97ebc4fd5e590f03cced0fb5eccd1751a89670 |
|
| MD5 | ed7e982679e54c6075bded578c0a81ec |
|
| BLAKE2b-256 | 702ef39fadb7d60e9414224d75d150ea7729272e5690d4120866078084c764d7 |
File details
Details for the file eth_utils-1.3.0-py3-none-any.whl.
File metadata
- Download URL: eth_utils-1.3.0-py3-none-any.whl
- Upload date:
- Size: 17.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 29f2a7bb85ea30e89867d887ced9ee55fc0c7b3823c10db9872423b052b11340 |
|
| MD5 | cf51d9528fb0f78ae17a15cbc0de37ba |
|
| BLAKE2b-256 | ac965b6e33beeabd23df64294a023d7c7b835cf9382b042155c90608d936a9b3 |
