# eth-account
[](https://discord.gg/GHryRvPB84)
[](https://circleci.com/gh/ethereum/eth-account)
[](https://badge.fury.io/py/eth-account)
[](https://pypi.python.org/pypi/eth-account)
[](https://eth-account.readthedocs.io/en/latest/?badge=latest)
Sign Ethereum transactions and messages with local private keys
Read more in the [documentation on ReadTheDocs](https://eth-account.readthedocs.io/). [View the change log](https://eth-account.readthedocs.io/en/latest/release_notes.html).
## Quickstart
```sh
python -m pip install eth-account
```
## Developer Setup
If you would like to hack on eth-account, 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-account.git
cd eth-account
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install
```
To run the integration test cases, you need to install node and the custom cli tool as follows:
```sh
apt-get install -y nodejs # As sudo
./tests/integration/js-scripts/setup_node_v20.sh # As sudo
cd tests/integration/js-scripts
npm install -g . # As sudo
```
### 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-account",
"name": "eth-account",
"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/22/6e/bb724215e8b49a09c1172663418a6a7486244c1c8e765c66ad8df7234583/eth_account-0.12.2.tar.gz",
"platform": null,
"description": "# eth-account\n\n[](https://discord.gg/GHryRvPB84)\n[](https://circleci.com/gh/ethereum/eth-account)\n[](https://badge.fury.io/py/eth-account)\n[](https://pypi.python.org/pypi/eth-account)\n[](https://eth-account.readthedocs.io/en/latest/?badge=latest)\n\nSign Ethereum transactions and messages with local private keys\n\nRead more in the [documentation on ReadTheDocs](https://eth-account.readthedocs.io/). [View the change log](https://eth-account.readthedocs.io/en/latest/release_notes.html).\n\n## Quickstart\n\n```sh\npython -m pip install eth-account\n```\n\n## Developer Setup\n\nIf you would like to hack on eth-account, 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-account.git\ncd eth-account\nvirtualenv -p python3 venv\n. venv/bin/activate\npython -m pip install -e \".[dev]\"\npre-commit install\n```\n\nTo run the integration test cases, you need to install node and the custom cli tool as follows:\n\n```sh\napt-get install -y nodejs # As sudo\n./tests/integration/js-scripts/setup_node_v20.sh # As sudo\ncd tests/integration/js-scripts\nnpm install -g . # As sudo\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": "eth-account: Sign Ethereum transactions and messages with local private keys",
"version": "0.12.2",
"project_urls": {
"Homepage": "https://github.com/ethereum/eth-account"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31496c79ae238d8c35150fa3f57da64cded52bd1326cec91d16210fdab047822",
"md5": "a5525a6d9df1ecc2c827c3b2abd785cc",
"sha256": "dcaeca6f30b50d0b98557396eaa217113c5cdea61687e424c527c91d4048cd6b"
},
"downloads": -1,
"filename": "eth_account-0.12.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5525a6d9df1ecc2c827c3b2abd785cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 355670,
"upload_time": "2024-04-15T20:52:58",
"upload_time_iso_8601": "2024-04-15T20:52:58.021717Z",
"url": "https://files.pythonhosted.org/packages/31/49/6c79ae238d8c35150fa3f57da64cded52bd1326cec91d16210fdab047822/eth_account-0.12.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "226ebb724215e8b49a09c1172663418a6a7486244c1c8e765c66ad8df7234583",
"md5": "be5d673ca751518ac2ac6affb09fe6d7",
"sha256": "abb995aff8db969fecf2e1233d307bf69389623bb6fd1cdbfbd96725f7449ebd"
},
"downloads": -1,
"filename": "eth_account-0.12.2.tar.gz",
"has_sig": false,
"md5_digest": "be5d673ca751518ac2ac6affb09fe6d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 713681,
"upload_time": "2024-04-15T20:53:01",
"upload_time_iso_8601": "2024-04-15T20:53:01.143687Z",
"url": "https://files.pythonhosted.org/packages/22/6e/bb724215e8b49a09c1172663418a6a7486244c1c8e765c66ad8df7234583/eth_account-0.12.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 20:53:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethereum",
"github_project": "eth-account",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "eth-account"
}
JSON
