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.5.0.tar.gz (49.3 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ssz-0.5.0.tar.gz
Algorithm Hash digest
SHA256 5e0fe0483c5c9bdf3ea0fa957986b48ca34c784af57e39257863dd3743e20861
MD5 0e7aeb851840422c27ffe1dc3b63af49
BLAKE2b-256 8b011cc59fe2b4eb6c424cdbd6f54cce5333c622178789b6666face4eb4f385d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ssz-0.5.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.11.5

File hashes

Hashes for ssz-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 111dec40bee7cb7c3d52fe621a2247d5420ab999ffc0cbecb470782c28b56414
MD5 8388375aabd875fd3cbfc2fb34b4934f
BLAKE2b-256 a3182f30c6e80dc6fc799399f8da2907a401ec5c21d9ed4553cc2079ca427deb

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