| Name | rlp JSON |
| Version |
4.0.1
JSON |
| download |
| home_page | https://github.com/ethereum/pyrlp |
| Summary | rlp: A package for Recursive Length Prefix encoding and decoding |
| upload_time | 2024-04-24 16:40:46 |
| maintainer | None |
| docs_url | None |
| author | jnnk |
| requires_python | <4,>=3.8 |
| license | MIT |
| keywords |
rlp
ethereum
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyrlp
[](https://discord.gg/GHryRvPB84)
[](https://circleci.com/gh/ethereum/pyrlp)
[](https://badge.fury.io/py/rlp)
[](https://pypi.python.org/pypi/rlp)
[](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"`
Raw data
{
"_id": null,
"home_page": "https://github.com/ethereum/pyrlp",
"name": "rlp",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "rlp ethereum",
"author": "jnnk",
"author_email": "jnnknnj@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0f/49/bcd4d3f9210ed78749eab04d236eeb98f98fbcc16977f308ee4637c1bad8/rlp-4.0.1.tar.gz",
"platform": null,
"description": "# pyrlp\n\n[](https://discord.gg/GHryRvPB84)\n[](https://circleci.com/gh/ethereum/pyrlp)\n[](https://badge.fury.io/py/rlp)\n[](https://pypi.python.org/pypi/rlp)\n[](https://pyrlp.readthedocs.io/en/latest/?badge=latest)\n\nA package for Recursive Length Prefix encoding and decoding\n\nRead more in the [documentation on ReadTheDocs](https://pyrlp.readthedocs.io/). [View the change log](https://pyrlp.readthedocs.io/en/latest/release_notes.html).\n\n## Quickstart\n\n```sh\npython -m pip install rlp\n```\n\n## Developer Setup\n\nIf you would like to hack on pyrlp, please check out the\n[Snake Charmers Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)\nfor information on how we do:\n\n- Testing\n- Pull Requests\n- Documentation\n\nWe use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once\ninstalled, it will run automatically with every commit. You can also run it manually\nwith `make lint`. If you need to make a commit that skips the `pre-commit` checks, you\ncan do so with `git commit --no-verify`.\n\n### Development Environment Setup\n\nYou can set up your dev environment with:\n\n```sh\ngit clone git@github.com:ethereum/pyrlp.git\ncd pyrlp\nvirtualenv -p python3 venv\n. venv/bin/activate\npython -m pip install -e \".[dev]\"\npre-commit install\n```\n\n### Release setup\n\nTo release a new version:\n\n```sh\nmake release bump=$$VERSION_PART_TO_BUMP$$\n```\n\n#### How to bumpversion\n\nThe version format for this repo is `{major}.{minor}.{patch}` for stable, and\n`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).\n\nTo issue the next version in line, specify which part to bump,\nlike `make release bump=minor` or `make release bump=devnum`. This is typically done from the\nmain branch, except when releasing a beta (in which case the beta is released from main,\nand the previous stable branch is released from said branch).\n\nIf you are in a beta version, `make release bump=stage` will switch to a stable.\n\nTo issue an unstable version when the current version is stable, specify the\nnew version explicitly, like `make release bump=\"--new-version 4.0.0-alpha.1 devnum\"`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "rlp: A package for Recursive Length Prefix encoding and decoding",
"version": "4.0.1",
"project_urls": {
"Homepage": "https://github.com/ethereum/pyrlp"
},
"split_keywords": [
"rlp",
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59033ae09a1c43657d17530dd98de6e381cc66ac514daa67000ccf99afc808fc",
"md5": "b839943e2f6b7de2ff503fb2670456bd",
"sha256": "ff6846c3c27b97ee0492373aa074a7c3046aadd973320f4fffa7ac45564b0258"
},
"downloads": -1,
"filename": "rlp-4.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b839943e2f6b7de2ff503fb2670456bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 20639,
"upload_time": "2024-04-24T16:40:43",
"upload_time_iso_8601": "2024-04-24T16:40:43.962032Z",
"url": "https://files.pythonhosted.org/packages/59/03/3ae09a1c43657d17530dd98de6e381cc66ac514daa67000ccf99afc808fc/rlp-4.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f49bcd4d3f9210ed78749eab04d236eeb98f98fbcc16977f308ee4637c1bad8",
"md5": "c7d5f4dd9530d1c2ca9e1f227bbc2f8d",
"sha256": "bcefb11013dfadf8902642337923bd0c786dc8a27cb4c21da6e154e52869ecb1"
},
"downloads": -1,
"filename": "rlp-4.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c7d5f4dd9530d1c2ca9e1f227bbc2f8d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 33710,
"upload_time": "2024-04-24T16:40:46",
"upload_time_iso_8601": "2024-04-24T16:40:46.068167Z",
"url": "https://files.pythonhosted.org/packages/0f/49/bcd4d3f9210ed78749eab04d236eeb98f98fbcc16977f308ee4637c1bad8/rlp-4.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 16:40:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethereum",
"github_project": "pyrlp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "rlp"
}
