https://github.com/ethereum/py-ssz

Python implementation of the Simple Serialize encoding and decoding
https://github.com/ethereum/py-ssz

ssz

Last synced: 3 months ago
JSON representation

Python implementation of the Simple Serialize encoding and decoding

• Host: GitHub
• URL: https://github.com/ethereum/py-ssz
• Owner: ethereum
• License: mit
• Created: 2018-10-18T17:41:29.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-19T21:37:34.000Z (9 months ago)
• Last Synced: 2024-09-28T07:02:01.798Z (3 months ago)
• Topics: ssz
• Language: Python
• Size: 826 KB
• Stars: 32
• Watchers: 12
• Forks: 22
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# py-ssz

[![Join the conversation on Discord](https://img.shields.io/discord/809793915578089484?color=blue&label=chat&logo=discord&logoColor=white)](https://discord.gg/GHryRvPB84)

[![Build Status](https://circleci.com/gh/ethereum/py-ssz.svg?style=shield)](https://circleci.com/gh/ethereum/py-ssz)

[![PyPI version](https://badge.fury.io/py/ssz.svg)](https://badge.fury.io/py/ssz)

[![Python versions](https://img.shields.io/pypi/pyversions/ssz.svg)](https://pypi.python.org/pypi/ssz)

[![Docs build](https://readthedocs.org/projects/ssz/badge/?version=latest)](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 [email protected]: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"`