Metadata-Version: 2.1
Name: rlp
Version: 4.0.1
Summary: rlp: A package for Recursive Length Prefix encoding and decoding
Home-page: https://github.com/ethereum/pyrlp
Author: jnnk
Author-email: jnnknnj@gmail.com
License: MIT
Description: # pyrlp
        
        [![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/pyrlp.svg?style=shield)](https://circleci.com/gh/ethereum/pyrlp)
        [![PyPI version](https://badge.fury.io/py/rlp.svg)](https://badge.fury.io/py/rlp)
        [![Python versions](https://img.shields.io/pypi/pyversions/rlp.svg)](https://pypi.python.org/pypi/rlp)
        [![Docs build](https://readthedocs.org/projects/pyrlp/badge/?version=latest)](https://pyrlp.readthedocs.io/en/latest/?badge=latest)
        
        A package for Recursive Length Prefix encoding and decoding
        
        Read more in the [documentation on ReadTheDocs](https://pyrlp.readthedocs.io/). [View the change log](https://pyrlp.readthedocs.io/en/latest/release_notes.html).
        
        ## Quickstart
        
        ```sh
        python -m pip install rlp
        ```
        
        ## Developer Setup
        
        If you would like to hack on pyrlp, 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 git@github.com:ethereum/pyrlp.git
        cd pyrlp
        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"`
        
Keywords: rlp ethereum
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8, <4
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: docs
Provides-Extra: rust-backend
Provides-Extra: dev
