# py-ssz
[](https://discord.gg/GHryRvPB84)
[](https://circleci.com/gh/ethereum/py-ssz)
[](https://badge.fury.io/py/ssz)
[](https://pypi.python.org/pypi/ssz)
[](https://ssz.readthedocs.io/en/latest/?badge=latest)
Python implementation of the Simple Serialization encoding and decoding
Read more in the [documentation on ReadTheDocs](https://ssz.readthedocs.io/). [View the change log](https://ssz.readthedocs.io/en/latest/release_notes.html).
## Quickstart
```sh
python -m pip install ssz
```
## Developer Setup
If you would like to hack on py-ssz, 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:ethereum/py-ssz.git
cd py-ssz
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/py-ssz",
"name": "ssz",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "ethereum",
"author": "The Ethereum Foundation",
"author_email": "snakecharmers@ethereum.org",
"download_url": "https://files.pythonhosted.org/packages/8b/01/1cc59fe2b4eb6c424cdbd6f54cce5333c622178789b6666face4eb4f385d/ssz-0.5.0.tar.gz",
"platform": null,
"description": "# py-ssz\n\n[](https://discord.gg/GHryRvPB84)\n[](https://circleci.com/gh/ethereum/py-ssz)\n[](https://badge.fury.io/py/ssz)\n[](https://pypi.python.org/pypi/ssz)\n[](https://ssz.readthedocs.io/en/latest/?badge=latest)\n\nPython implementation of the Simple Serialization encoding and decoding\n\nRead more in the [documentation on ReadTheDocs](https://ssz.readthedocs.io/). [View the change log](https://ssz.readthedocs.io/en/latest/release_notes.html).\n\n## Quickstart\n\n```sh\npython -m pip install ssz\n```\n\n## Developer Setup\n\nIf you would like to hack on py-ssz, 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:ethereum/py-ssz.git\ncd py-ssz\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": "ssz: Python implementation of the Simple Serialization encoding and decoding",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/ethereum/py-ssz"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a3182f30c6e80dc6fc799399f8da2907a401ec5c21d9ed4553cc2079ca427deb",
"md5": "8388375aabd875fd3cbfc2fb34b4934f",
"sha256": "111dec40bee7cb7c3d52fe621a2247d5420ab999ffc0cbecb470782c28b56414"
},
"downloads": -1,
"filename": "ssz-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8388375aabd875fd3cbfc2fb34b4934f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 44413,
"upload_time": "2024-04-01T19:19:22",
"upload_time_iso_8601": "2024-04-01T19:19:22.817985Z",
"url": "https://files.pythonhosted.org/packages/a3/18/2f30c6e80dc6fc799399f8da2907a401ec5c21d9ed4553cc2079ca427deb/ssz-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b011cc59fe2b4eb6c424cdbd6f54cce5333c622178789b6666face4eb4f385d",
"md5": "0e7aeb851840422c27ffe1dc3b63af49",
"sha256": "5e0fe0483c5c9bdf3ea0fa957986b48ca34c784af57e39257863dd3743e20861"
},
"downloads": -1,
"filename": "ssz-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "0e7aeb851840422c27ffe1dc3b63af49",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 49256,
"upload_time": "2024-04-01T19:19:24",
"upload_time_iso_8601": "2024-04-01T19:19:24.914741Z",
"url": "https://files.pythonhosted.org/packages/8b/01/1cc59fe2b4eb6c424cdbd6f54cce5333c622178789b6666face4eb4f385d/ssz-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 19:19:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethereum",
"github_project": "py-ssz",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "ssz"
}
JSON
