Skip to main content

pulse-ssz: Python implementation of the Simple Serialization encoding and decoding

Project description

py-ssz

Join the chat at https://gitter.im/ethereum/py-ssz 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

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
  • Code Style
  • Documentation

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
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:

# Test flake8
when-changed -v -s -r -1 ssz/ tests/ -c "clear; flake8 ssz tests && echo 'flake8 success' || echo 'error'"

Run multi-process tests in one command, but without color:

# 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:

cd venv
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on py-ssz failed'" ../tests ../ssz

Release setup

For Debian-like systems:

apt install pandoc

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 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"

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

pulse-ssz-0.4.0.tar.gz (34.5 kB view details)

Uploaded Source

Built Distribution

pulse_ssz-0.4.0-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pulse-ssz-0.4.0.tar.gz
  • Upload date:
  • Size: 34.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for pulse-ssz-0.4.0.tar.gz
Algorithm Hash digest
SHA256 423a2996bacb807c4fc232698546d1ffacabdf5deca43b85067d9de43623c629
MD5 be0f46abade16af0ad26f10044a74d3b
BLAKE2b-256 9f9a86b0492a7d7b7ddfbfb7adb9597f13e8684e061fc17236735b26109d3196

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pulse_ssz-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 45.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for pulse_ssz-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fc3ec5d18355f41483820b3a91b0e781c6f4f9f63c89977808dbccbaa71922af
MD5 aab0441d5b2c96b4f97e7f7bc96d542e
BLAKE2b-256 396b4a48f0d75d73ab7c4cbc5b61c7c522224afc825bc23ad412dc1db147c4e9

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