# platon-hash
[](https://gitter.im/platonnetwork/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://circleci.com/gh/platonnetwork/platon-hash)
[](https://badge.fury.io/py/platon-hash)
[](https://pypi.python.org/pypi/platon-hash)
[](http://platon-hash.readthedocs.io/en/latest/?badge=latest)
The Platon hashing function, keccak256, sometimes (erroneously) called sha3
Note: the similarly named [pyethash](https://github.com/platonnetwork/ethash)
has a completely different use: it generates proofs of work.
This is a low-level library, intended to be used internally by other Platon tools.
If you're looking for a convenient hashing tool, check out
[`platon_utils.keccak()`](https://Platon-utils.readthedocs.io/en/stable/utilities.html#keccak-bytes-int-bool-text-str-hexstr-str-bytes)
which will be a little friendlier, and provide access to other helpful utilities.
Read more in the [documentation on ReadTheDocs](https://platon-hash.readthedocs.io/). [View the change log](https://platon-hash.readthedocs.io/en/latest/release_notes.html).
## Quickstart
```sh
pip install platon-hash[pycryptodome]
```
```py
>>> from platon_hash.auto import keccak
>>> keccak(b'')
b"\xc5\xd2F\x01\x86\xf7#<\x92~}\xb2\xdc\xc7\x03\xc0\xe5\x00\xb6S\xca\x82';{\xfa\xd8\x04]\x85\xa4p"
```
See the [docs](http://platon-hash.readthedocs.io/en/latest/quickstart.html#quickstart)
for more about choosing and installing backends.
## Developer Setup
If you would like to hack on platon-hash, please check out the [Snake Charmers
Tactical Manual](https://github.com/platonnetwork/snake-charmers-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:
```sh
git clone git@github.com:platonnetwork/platon-hash.git
cd platon-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:
```sh
# Test flake8
when-changed -v -s -r -1 platon_hash/ tests/ -c "clear; flake8 platon_hash tests && echo 'flake8 success' || echo 'error'"
```
Run multi-process tests in one command, but without color:
```sh
# 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:
```sh
cd venv
ptw --onfail "notify-send -t 5000 'Test failure' 'python 3 test on platon-hash failed'" ../tests ../platon_hash
```
### Release setup
For Debian-like systems:
```
apt 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`. This is typically done from the
master branch, except when releasing a beta (in which case the beta is released from master,
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"`
Raw data
{
"_id": null,
"home_page": "https://github.com/platonnetwork/platon-hash",
"name": "platon-hash",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5, <4",
"maintainer_email": "",
"keywords": "platon",
"author": "Shinnng",
"author_email": "shinnng@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/15/0a/1e9edc4cf980b9dca91d8d4af5dabdc076f64a218553886f17546b17c763/platon-hash-1.2.1.tar.gz",
"platform": null,
"description": "# platon-hash\n\n[](https://gitter.im/platonnetwork/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[](https://circleci.com/gh/platonnetwork/platon-hash)\n[](https://badge.fury.io/py/platon-hash)\n[](https://pypi.python.org/pypi/platon-hash)\n[](http://platon-hash.readthedocs.io/en/latest/?badge=latest)\n \n\nThe Platon hashing function, keccak256, sometimes (erroneously) called sha3\n\nNote: the similarly named [pyethash](https://github.com/platonnetwork/ethash)\nhas a completely different use: it generates proofs of work.\n\nThis is a low-level library, intended to be used internally by other Platon tools.\nIf you're looking for a convenient hashing tool, check out\n[`platon_utils.keccak()`](https://Platon-utils.readthedocs.io/en/stable/utilities.html#keccak-bytes-int-bool-text-str-hexstr-str-bytes)\nwhich will be a little friendlier, and provide access to other helpful utilities.\n\nRead more in the [documentation on ReadTheDocs](https://platon-hash.readthedocs.io/). [View the change log](https://platon-hash.readthedocs.io/en/latest/release_notes.html).\n\n\n## Quickstart\n\n```sh\npip install platon-hash[pycryptodome]\n```\n\n```py\n>>> from platon_hash.auto import keccak\n>>> keccak(b'')\nb\"\\xc5\\xd2F\\x01\\x86\\xf7#<\\x92~}\\xb2\\xdc\\xc7\\x03\\xc0\\xe5\\x00\\xb6S\\xca\\x82';{\\xfa\\xd8\\x04]\\x85\\xa4p\"\n```\n\nSee the [docs](http://platon-hash.readthedocs.io/en/latest/quickstart.html#quickstart)\nfor more about choosing and installing backends.\n\n## Developer Setup\n\nIf you would like to hack on platon-hash, please check out the [Snake Charmers\nTactical Manual](https://github.com/platonnetwork/snake-charmers-tactical-manual)\nfor information on how we do:\n\n- Testing\n- Pull Requests\n- Code Style\n- Documentation\n\n### Development Environment Setup\n\nYou can set up your dev environment with:\n\n```sh\ngit clone git@github.com:platonnetwork/platon-hash.git\ncd platon-hash\nvirtualenv -p python3 venv\n. venv/bin/activate\npip install -e .[dev]\n```\n\n### Testing Setup\n\nDuring development, you might like to have tests run on every file save.\n\nShow flake8 errors on file change:\n\n```sh\n# Test flake8\nwhen-changed -v -s -r -1 platon_hash/ tests/ -c \"clear; flake8 platon_hash tests && echo 'flake8 success' || echo 'error'\"\n```\n\nRun multi-process tests in one command, but without color:\n\n```sh\n# in the project root:\npytest --numprocesses=4 --looponfail --maxfail=1\n# the same thing, succinctly:\npytest -n 4 -f --maxfail=1\n```\n\nRun in one thread, with color and desktop notifications:\n\n```sh\ncd venv\nptw --onfail \"notify-send -t 5000 'Test failure' 'python 3 test on platon-hash failed'\" ../tests ../platon_hash\n```\n\n### Release setup\n\nFor Debian-like systems:\n```\napt install pandoc\n```\n\nTo release a new version:\n\n```sh\nmake release bump=$$VERSION_PART_TO_BUMP$$\n```\n\n#### How to bumpversion\n\nThe version format for this repo is `{major}.{minor}.{patch}` for stable, and\n`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).\n\nTo issue the next version in line, specify which part to bump,\nlike `make release bump=minor` or `make release bump=devnum`. This is typically done from the\nmaster branch, except when releasing a beta (in which case the beta is released from master,\nand the previous stable branch is released from said branch).\n\nIf you are in a beta version, `make release bump=stage` will switch to a stable.\n\nTo issue an unstable version when the current version is stable, specify the\nnew version explicitly, like `make release bump=\"--new-version 4.0.0-alpha.1 devnum\"`\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "platon-hash: The Platon hashing function, keccak256, sometimes (erroneously) called sha3",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/platonnetwork/platon-hash"
},
"split_keywords": [
"platon"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "242cbf7b78369e1908a05717e92b1aff024ac73e54a84d040c9082dee8eb993a",
"md5": "c15b05a3471f8b7c03497ff1609cc649",
"sha256": "4a52038dc132bccdea76e6933b1c496f201834be5ad09e98b990ea23eee3ec8e"
},
"downloads": -1,
"filename": "platon_hash-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c15b05a3471f8b7c03497ff1609cc649",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5, <4",
"size": 9928,
"upload_time": "2022-06-01T08:08:18",
"upload_time_iso_8601": "2022-06-01T08:08:18.417560Z",
"url": "https://files.pythonhosted.org/packages/24/2c/bf7b78369e1908a05717e92b1aff024ac73e54a84d040c9082dee8eb993a/platon_hash-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "150a1e9edc4cf980b9dca91d8d4af5dabdc076f64a218553886f17546b17c763",
"md5": "c9e7485a7b8aecc095b9b549d2e9d209",
"sha256": "cdf2de5cabee39e9c152c7242e83d4523f8e743f48872a32a12c32c01c2858cd"
},
"downloads": -1,
"filename": "platon-hash-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "c9e7485a7b8aecc095b9b549d2e9d209",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5, <4",
"size": 12320,
"upload_time": "2022-06-01T08:08:20",
"upload_time_iso_8601": "2022-06-01T08:08:20.500079Z",
"url": "https://files.pythonhosted.org/packages/15/0a/1e9edc4cf980b9dca91d8d4af5dabdc076f64a218553886f17546b17c763/platon-hash-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-01 08:08:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "platonnetwork",
"github_project": "platon-hash",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "platon-hash"
}
JSON
