Skip to main content

ssz: Python implementation of the Simple Serialization encoding and decoding

Project description

py-ssz

Join the conversation on Discord Build Status PyPI version Python versions Docs build

Python implementation of the Simple Serialization encoding and decoding

Read more in the documentation on ReadTheDocs. View the change log.

Quickstart

python -m pip install ssz

Developer Setup

If you would like to hack on py-ssz, please check out the Snake Charmers Tactical Manual for information on how we do:

  • Testing
  • Pull Requests
  • Documentation

We use pre-commit 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:

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:

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"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssz-0.4.0.tar.gz (49.1 kB view details)

Uploaded Source

Built Distribution

ssz-0.4.0-py3-none-any.whl (44.4 kB view details)

Uploaded Python 3

File details

Details for the file ssz-0.4.0.tar.gz.

File metadata

  • Download URL: ssz-0.4.0.tar.gz
  • Upload date:
  • Size: 49.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for ssz-0.4.0.tar.gz
Algorithm Hash digest
SHA256 f8089db5fb3f7fb43805d255fee286d630652e9d476ca529951a7429ee8e48b3
MD5 fc85d1cc00a9cdd57bcf0e3ff5fa6812
BLAKE2b-256 dcee0e7b3d711be43d02cf9dccd7eff4573d6097a991a01d836da5f8197b587e

See more details on using hashes here.

File details

Details for the file ssz-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: ssz-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 44.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for ssz-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a7fa5aaa42eb5b69a42b965f16aa6b688d0ab587768a2f13bed4c46ccf07c1ba
MD5 d5af327798dffb4d89d3b9a6df70433d
BLAKE2b-256 d06c07eec06a63a3e699d97164fa9e765557116f6e4880df1a726b1e7efd713b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page