ETH_RLP(1)

NAME
eth_rlp - eth-rlp Documentation

RLP definitions for common Ethereum objects in Python

INSTALLATION

    python -m pip install eth-rlp

Import with

    from eth_rlp import HashableRLP

  eth_rlp package

  HashableRLP

  Release Notes

  eth-rlp v2.2.0 (2025-02-04)

  Features

•   Merge template, adding py313 support and replacing bumpversion with bump-my-version. (#26)

  Internal Changes - for eth-rlp Contributors

•   Merge template, fixing docs CI, add nightly CI runs (#24)

  eth-rlp v2.1.0 (2024-03-19)

  Internal Changes - for eth-rlp Contributors

•   Bump to hexbytes>=1.2.0 and add blocklint to linting (#22)

  eth-rlp v2.0.0 (2024-03-04)

  Breaking Changes

•   Bump hexbytes dependency to >=1.0.0 (#21)

  Features

•   Add Python 3.12 support (#18)

  Internal Changes - for eth-rlp Contributors

•   Add windows-wheel CI job for py312, set both py311 and py312 to use latest patch version (#20)

•   Add py.typed file, move misplaced newsfragment, correct py version pins for typing-extensions (#21)

  eth-rlp v1.0.1 (2024-01-25)

  Bugfixes

•   Add the missing typing_extensions module requirement for Python <= 3.11 (#19)

  eth-rlp v1.0.0 (2023-12-06)

  Breaking Changes

•   Drop python 3.7 support (#16)

  Features

•   Add python 3.11 support (#16)

  Internal Changes - for eth-rlp Contributors

•   Merge updates from template, including use pre-commit for linting, and changing the name of the master branch to main (#16)

  eth-rlp v0.3.0 (2022-01-19)

  Eth_Rlp 0.3.0 (2022-01-19)

  Features

•   Add support for python 3.8-3.10 (#12)

•   Require eth-utils>=2.0,<3 (#14)

  Deprecations and Removals

•   Remove support for Python 3.6 (#13)

  eth-rlp v0.2.0 (2020-09-01)

  Features

•   Add support for pyrlp v2.0.0-alpha.1 (as long as you don't use pypy) (#8)

  Deprecations and Removals

•   Dropped py3.5 support (#7)

  Miscellaneous changes

•   Merge updates from the project template (#7)

  v0.1.2

Released April 25, 2018

•   Add as_dict() as a shim for joint v0/v1 compatibility

  v0.1.1

Released April 25, 2018

•   Add support for rlp version 1 (but still backwards-compatible with v0)

  v0.1.0

Released Mar 1, 2018

•   Marked stable

•   Upgraded eth-utils and hexbytes to stable versions

•   Add pypy3 support

  v0.1.0-alpha.2

Released Jan 30, 2018

•   First working version

•   Some docs

•   New basic tests, that pass

  v0.1.0-alpha.1

•   Launched repository, claimed names for pip, RTD, github, etc

  Contributing

Thank you for your interest in contributing! We welcome all contributions no matter their size. Please read along to learn how to get started. If you get stuck, feel free to ask for help in Ethereum Python Discord server.

  Setting the stage

To get started, fork the repository to your own github account, then clone it to your development machine:

    git clone git@github.com:your-github-username/eth-rlp.git

Next, install the development dependencies. We recommend using a virtual environment, such as virtualenv.

    cd eth-rlp
    virtualenv -p python venv
    . venv/bin/activate
    python -m pip install -e ".[dev]"
    pre-commit install

  Running the tests

A great way to explore the code base is to run the tests.

We can run all tests with:

    pytest tests

  Code Style

We use pre-commit to enforce a consistent code style across the library. This tool runs automatically with every commit, but 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.

This library uses type hints, which are enforced by the mypy tool (part of the pre-commit checks). All new code is required to land with type hints, with the exception of code within the tests directory.

  Documentation

Good documentation will lead to quicker adoption and happier users. Please check out our guide on how to create documentation for the Python Ethereum ecosystem.

  Pull Requests

It's a good idea to make pull requests early on. A pull request represents the start of a discussion, and doesn't necessarily need to be the final, finished submission.

GitHub's documentation for working on pull requests is available here.

Once you've made a pull request, take a look at the Circle CI build status in the GitHub interface and make sure all tests are passing. In general pull requests that do not pass the CI build yet won't get reviewed unless explicitly requested.

If the pull request introduces changes that should be reflected in the release notes, please add a newsfragment file as explained here.

If possible, the change to the release notes file should be included in the commit that introduces the feature or bugfix.

  Releasing

Releases are 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).

  Final test before each release

Before releasing a new version, build and test the package that will be released:

    git checkout main && git pull
    make package-test

This will build the package and install it in a temporary virtual environment. Follow the instructions to activate the venv and test whatever you think is important.

You can also preview the release notes:

    towncrier --draft

  Build the release notes

Before bumping the version number, build the release notes. You must include the part of the version to bump (see below), which changes how the version number will show in the release notes.

    make notes bump=$$VERSION_PART_TO_BUMP$$

If there are any errors, be sure to re-run make notes until it works.

  Push the release to github & pypi

After confirming that the release package looks okay, release a new version:

    make release bump=$$VERSION_PART_TO_BUMP$$

This command will:

•   Bump the version number as specified in .pyproject.toml and setup.py.

•   Create a git commit and tag for the new version.

•   Build the package.

•   Push the commit and tag to github.

•   Push the new package files to pypi.

  Which version part to bump

$$VERSION_PART_TO_BUMP$$ must be one of: major, minor, patch, stage, or devnum.

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).

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"

You can see what the result of bumping any particular version part would be with bump-my-version show-bump

  Code of Conduct

  Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

  Our Standards

Examples of behavior that contributes to creating a positive environment include:

•   Using welcoming and inclusive language

•   Being respectful of differing viewpoints and experiences

•   Gracefully accepting constructive criticism

•   Focusing on what is best for the community

•   Showing empathy towards other community members

    Examples of unacceptable behavior by participants include:

•   The use of sexualized language or imagery and unwelcome sexual attention or advances

•   Trolling, insulting/derogatory comments, and personal or political attacks

•   Public or private harassment

•   Publishing others' private information, such as a physical or electronic address, without explicit permission

•   Other conduct which could reasonably be considered inappropriate in a professional setting

  Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

  Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

  Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at snakecharmers@ethereum.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

  Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

AUTHOR
The Ethereum Foundation

COPYRIGHT
2018-2023, The Ethereum Foundation