# eth-typing
[](https://discord.gg/GHryRvPB84)
[](https://circleci.com/gh/ethereum/eth-typing)
[](https://badge.fury.io/py/eth-typing)
[](https://pypi.python.org/pypi/eth-typing)
[](https://eth-typing.readthedocs.io/en/latest/?badge=latest)
Common type annotations for ethereum python packages.
Read more in the [documentation on ReadTheDocs](https://eth-typing.readthedocs.io/). [View the change log](https://eth-typing.readthedocs.io/en/latest/release_notes.html).
## Quickstart
```sh
python -m pip install eth-typing
```
## Developer Setup
If you would like to hack on eth-typing, 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/eth-typing.git
cd eth-typing
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install
```
### Network ChainIds
A list of `ChainId` constants reside in the eth-typing/networks.py file. This list should be kept
in sync with the network list available on
[chainid.network](https://chainid.network/chains_mini.json).
To keep the list up to date, run the following command:
```sh
python update_network_chain_ids.py
```
This will remove the original networks file and output a new file with the new networks added.
Check that the output file is correct and that constants are defined as expected. If
the shortName contains special characters it may not work as a constant variable name.
The script should be updated to transform names into valid constants as new cases occur.
### 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/eth-typing",
"name": "eth-typing",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "ethereum",
"author": "The Ethereum Foundation",
"author_email": "snakecharmers@ethereum.org",
"download_url": "https://files.pythonhosted.org/packages/33/32/d5a1bdf872f92a7c3361396b684aeba7abaabb341bd22a80029abcd1f68e/eth_typing-5.0.1.tar.gz",
"platform": null,
"description": "# eth-typing\n\n[](https://discord.gg/GHryRvPB84)\n[](https://circleci.com/gh/ethereum/eth-typing)\n[](https://badge.fury.io/py/eth-typing)\n[](https://pypi.python.org/pypi/eth-typing)\n[](https://eth-typing.readthedocs.io/en/latest/?badge=latest)\n\nCommon type annotations for ethereum python packages.\n\nRead more in the [documentation on ReadTheDocs](https://eth-typing.readthedocs.io/). [View the change log](https://eth-typing.readthedocs.io/en/latest/release_notes.html).\n\n## Quickstart\n\n```sh\npython -m pip install eth-typing\n```\n\n## Developer Setup\n\nIf you would like to hack on eth-typing, please check out the [Snake Charmers\nTactical 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/eth-typing.git\ncd eth-typing\nvirtualenv -p python3 venv\n. venv/bin/activate\npython -m pip install -e \".[dev]\"\npre-commit install\n```\n\n### Network ChainIds\n\nA list of `ChainId` constants reside in the eth-typing/networks.py file. This list should be kept\nin sync with the network list available on\n[chainid.network](https://chainid.network/chains_mini.json).\n\nTo keep the list up to date, run the following command:\n\n```sh\npython update_network_chain_ids.py\n```\n\nThis will remove the original networks file and output a new file with the new networks added.\n\nCheck that the output file is correct and that constants are defined as expected. If\nthe shortName contains special characters it may not work as a constant variable name.\nThe script should be updated to transform names into valid constants as new cases occur.\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": "eth-typing: Common type annotations for ethereum python packages",
"version": "5.0.1",
"project_urls": {
"Homepage": "https://github.com/ethereum/eth-typing"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1aefa66ff9b83df51b83c1af468fc7b5e4a3855d9e3c01e2365ecfe1c5e84077",
"md5": "001168df1a1d45003a661c8d4e9531f5",
"sha256": "f30d1af16aac598f216748a952eeb64fbcb6e73efa691d2de31148138afe96de"
},
"downloads": -1,
"filename": "eth_typing-5.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "001168df1a1d45003a661c8d4e9531f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 20085,
"upload_time": "2024-10-14T20:12:27",
"upload_time_iso_8601": "2024-10-14T20:12:27.791280Z",
"url": "https://files.pythonhosted.org/packages/1a/ef/a66ff9b83df51b83c1af468fc7b5e4a3855d9e3c01e2365ecfe1c5e84077/eth_typing-5.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3332d5a1bdf872f92a7c3361396b684aeba7abaabb341bd22a80029abcd1f68e",
"md5": "3874a85856a10a87f67393ddc361644e",
"sha256": "83debf88c9df286db43bb7374974681ebcc9f048fac81be2548dbc549a3203c0"
},
"downloads": -1,
"filename": "eth_typing-5.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3874a85856a10a87f67393ddc361644e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 22716,
"upload_time": "2024-10-14T20:12:30",
"upload_time_iso_8601": "2024-10-14T20:12:30.629312Z",
"url": "https://files.pythonhosted.org/packages/33/32/d5a1bdf872f92a7c3361396b684aeba7abaabb341bd22a80029abcd1f68e/eth_typing-5.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-14 20:12:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethereum",
"github_project": "eth-typing",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "eth-typing"
}
JSON
