ssz: Python implementation of the Simple Serialization encoding and decoding
Project description
py-ssz
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"
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ssz-0.3.0.tar.gz.
File metadata
- Download URL: ssz-0.3.0.tar.gz
- Upload date:
- Size: 37.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e62da591a1ac01ca6b2bc3a7f0e8230cafac5a7c691c652d9fad8bafa44d0a47 |
|
| MD5 | b54d7a7107913c5d7a6d0331b6b9fe2c |
|
| BLAKE2b-256 | d69e57b59ed73576878ba500e9b35a61c5ed4f28adfa4027d03b9af3b3ec9bf1 |
File details
Details for the file ssz-0.3.0-py3-none-any.whl.
File metadata
- Download URL: ssz-0.3.0-py3-none-any.whl
- Upload date:
- Size: 44.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3a8d36078ac951f84dbbed26d0849c0a9938ad7e2fbb8b3a05ca4db56a09aa2a |
|
| MD5 | 3d6eb9992f6706cb883955fb71b65bc7 |
|
| BLAKE2b-256 | 379beed7b67f404079e68e785dc2671e5191dfcf8ff197157cead3536ebee3cb |
