eth-hash: The Ethereum hashing function, keccak256, sometimes (erroneously) called sha3
Project description
The Ethereum hashing function, keccak256, sometimes (erroneously) called sha3
Note: the similarly named pyethash has a completely different use: it generates proofs of work.
This is a low-level library, intended to be used internally by other Ethereum tools. If you’re looking for a convenient hashing tool, check out `eth_utils.keccak() <https://github.com/ethereum/eth-utils#crypto-utils>`__ which will be a little friendlier, and provide access to other helpful utilities.
Read more in the documentation on ReadTheDocs. View the change log.
Quickstart
pip install eth-hash
Developer setup
If you would like to hack on eth-hash, please check out the Ethereum Development Tactical Manual for information on how we do:
Testing
Pull Requests
Code Style
Documentation
Development Environment Setup
You can set up your dev environment with:
git clone git@github.com:carver/eth-hash.git
cd eth-hash
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]
Testing Setup
During development, you might like to have tests run on every file save.
Show flake8 errors on file change:
# Test flake8
when-changed -v -s -r -1 eth_hash/ tests/ -c "clear; flake8 eth_hash tests && echo 'flake8 success' || echo 'error'"
Run multi-process tests in one command, but without color:
# in the project root:
pytest --numprocesses=4 --looponfail --maxfail=1
# the same thing, succinctly:
pytest -n 4 -f --maxfail=1
Run in one thread, with color and desktop notifications:
cd venv
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on eth-hash failed'" ../tests ../eth_hash
Release setup
For Debian-like systems:
apt install pandoc
To release a new version:
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"
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_hash-0.1.0a3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1aa705cf759f13d20a1fae5dc7f2e28e5129277d2b196b3a61e93dc265503586 |
|
MD5 | f3b6fc12e34e410d565d18bbf3ff29ca |
|
BLAKE2b-256 | 132f42bc2eee37f71ed0efb5531f2a6c87cbcac7cf1257e0729101d37db161ed |