# HexBytes
[](https://discord.gg/GHryRvPB84)
[](https://circleci.com/gh/ethereum/hexbytes)
[](https://badge.fury.io/py/hexbytes)
[](https://pypi.python.org/pypi/hexbytes)
[](https://hexbytes.readthedocs.io/en/latest/?badge=latest)
Python `bytes` subclass that decodes hex, with a readable console output
Read more in the [documentation on ReadTheDocs](https://hexbytes.readthedocs.io/). [View the change log](https://hexbytes.readthedocs.io/en/latest/release_notes.html).
## Quickstart
```sh
pythom -m pip install hexbytes
```
```py
# convert from bytes to a prettier representation at the console
>>> HexBytes(b"\x03\x08wf\xbfh\xe7\x86q\xd1\xeaCj\xe0\x87\xdat\xa1'a\xda\xc0 \x01\x1a\x9e\xdd\xc4\x90\x0b\xf1;")
HexBytes('0x03087766bf68e78671d1ea436ae087da74a12761dac020011a9eddc4900bf13b')
# HexBytes accepts the hex string representation as well, ignoring case and 0x prefixes
>>> hb = HexBytes('03087766BF68E78671D1EA436AE087DA74A12761DAC020011A9EDDC4900BF13B')
HexBytes('0x03087766bf68e78671d1ea436ae087da74a12761dac020011a9eddc4900bf13b')
# get the first byte:
>>> hb[0]
3
# show how many bytes are in the value
>>> len(hb)
32
# cast back to the basic `bytes` type
>>> bytes(hb)
b"\x03\x08wf\xbfh\xe7\x86q\xd1\xeaCj\xe0\x87\xdat\xa1'a\xda\xc0 \x01\x1a\x9e\xdd\xc4\x90\x0b\xf1;"
```
## Developer Setup
If you would like to hack on hexbytes, please check out the [Snake Charmers
Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)
for information on how we do:
- Testing
- Pull Requests
- Documentation
We use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once
installed, it will run automatically with every commit. You can also run it manually
with `make lint`. If you need to make a commit that skips the `pre-commit` checks, you
can do so with `git commit --no-verify`.
### Development Environment Setup
You can set up your dev environment with:
```sh
git clone git@github.com:carver/hexbytes.git
cd hexbytes
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install
```
### Release setup
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
main branch, except when releasing a beta (in which case the beta is released from main,
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/ethereum/hexbytes",
"name": "hexbytes",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8, <4",
"maintainer_email": "",
"keywords": "ethereum",
"author": "The Ethereum Foundation",
"author_email": "snakecharmers@ethereum.org",
"download_url": "https://files.pythonhosted.org/packages/50/16/307643e5997ca182a52dc00e0642d556ab47029ac027bd4df8a70ea3e49e/hexbytes-1.2.0.tar.gz",
"platform": null,
"description": "# HexBytes\n\n[](https://discord.gg/GHryRvPB84)\n[](https://circleci.com/gh/ethereum/hexbytes)\n[](https://badge.fury.io/py/hexbytes)\n[](https://pypi.python.org/pypi/hexbytes)\n[](https://hexbytes.readthedocs.io/en/latest/?badge=latest)\n\nPython `bytes` subclass that decodes hex, with a readable console output\n\nRead more in the [documentation on ReadTheDocs](https://hexbytes.readthedocs.io/). [View the change log](https://hexbytes.readthedocs.io/en/latest/release_notes.html).\n\n## Quickstart\n\n```sh\npythom -m pip install hexbytes\n```\n\n```py\n# convert from bytes to a prettier representation at the console\n>>> HexBytes(b\"\\x03\\x08wf\\xbfh\\xe7\\x86q\\xd1\\xeaCj\\xe0\\x87\\xdat\\xa1'a\\xda\\xc0 \\x01\\x1a\\x9e\\xdd\\xc4\\x90\\x0b\\xf1;\")\nHexBytes('0x03087766bf68e78671d1ea436ae087da74a12761dac020011a9eddc4900bf13b')\n\n# HexBytes accepts the hex string representation as well, ignoring case and 0x prefixes\n>>> hb = HexBytes('03087766BF68E78671D1EA436AE087DA74A12761DAC020011A9EDDC4900BF13B')\nHexBytes('0x03087766bf68e78671d1ea436ae087da74a12761dac020011a9eddc4900bf13b')\n\n# get the first byte:\n>>> hb[0]\n3\n\n# show how many bytes are in the value\n>>> len(hb)\n32\n\n# cast back to the basic `bytes` type\n>>> bytes(hb)\nb\"\\x03\\x08wf\\xbfh\\xe7\\x86q\\xd1\\xeaCj\\xe0\\x87\\xdat\\xa1'a\\xda\\xc0 \\x01\\x1a\\x9e\\xdd\\xc4\\x90\\x0b\\xf1;\"\n```\n\n## Developer Setup\n\nIf you would like to hack on hexbytes, please check out the [Snake Charmers\nTactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)\nfor information on how we do:\n\n- Testing\n- Pull Requests\n- Documentation\n\nWe use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once\ninstalled, it will run automatically with every commit. You can also run it manually\nwith `make lint`. If you need to make a commit that skips the `pre-commit` checks, you\ncan do so with `git commit --no-verify`.\n\n### Development Environment Setup\n\nYou can set up your dev environment with:\n\n```sh\ngit clone git@github.com:carver/hexbytes.git\ncd hexbytes\nvirtualenv -p python3 venv\n. venv/bin/activate\npython -m pip install -e \".[dev]\"\npre-commit install\n```\n\n### Release setup\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\nmain branch, except when releasing a beta (in which case the beta is released from main,\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "hexbytes: Python `bytes` subclass that decodes hex, with a readable console output",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/ethereum/hexbytes"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49959e09daf2ab2d60d5acabff4a529799d0ac3e022ac4ace14cfc4dc9187540",
"md5": "a627ef28623100990f3490e9928da28d",
"sha256": "bb243ab58b8d8390e3a753fbc9e3616f0f958df43d874e19ae0e4b746722a7e9"
},
"downloads": -1,
"filename": "hexbytes-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a627ef28623100990f3490e9928da28d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8, <4",
"size": 5933,
"upload_time": "2024-03-19T18:03:08",
"upload_time_iso_8601": "2024-03-19T18:03:08.843202Z",
"url": "https://files.pythonhosted.org/packages/49/95/9e09daf2ab2d60d5acabff4a529799d0ac3e022ac4ace14cfc4dc9187540/hexbytes-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5016307643e5997ca182a52dc00e0642d556ab47029ac027bd4df8a70ea3e49e",
"md5": "0dc58ae43d368f99c8c45d6b83b298b4",
"sha256": "965f1cc712e7b263c41fdf3fb36cf671ba6f59b895937cf33941a5c996ec3a5c"
},
"downloads": -1,
"filename": "hexbytes-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "0dc58ae43d368f99c8c45d6b83b298b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8, <4",
"size": 8255,
"upload_time": "2024-03-19T18:03:12",
"upload_time_iso_8601": "2024-03-19T18:03:12.915051Z",
"url": "https://files.pythonhosted.org/packages/50/16/307643e5997ca182a52dc00e0642d556ab47029ac027bd4df8a70ea3e49e/hexbytes-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 18:03:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethereum",
"github_project": "hexbytes",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "hexbytes"
}
JSON
