Skip to main content

eth-account: Sign Ethereum transactions and messages with local private keys

Project description

eth-account

Join the chat at https://gitter.im/ethereum/eth-account Build Status PyPI version Python versions Docs build

Sign Ethereum transactions and messages with local private keys

Read more in the documentation on ReadTheDocs. View the change log

Quickstart

pip install eth-account

Developer Setup

If you would like to hack on eth-account, please check out the Snake Charmers Tactical Manual for information on how we do:

  • Testing
  • Pull Requests
  • Code Style
  • Documentation

Development Environment Setup

You can set up your dev environment with:

git clone git@github.com:ethereum/eth-account.git
cd eth-account
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]

To run the integration test cases, you need to install node and the custom cli tool as follows:

apt-get install -y nodejs  # As sudo
./tests/integration/ethers-cli/setup_node_v12.sh  # As sudo
cd tests/integration/ethers-cli
npm install -g .  # As sudo

Testing Setup

During development, you might like to have tests run on every file save.

Show flake8 errors on file change:

# Test flake8
when-changed -v -s -r -1 eth_account/ tests/ -c "clear; flake8 eth_account tests && echo 'flake8 success' || echo 'error'"

Run multi-process tests in one command, but without color:

# in the project root:
pytest --numprocesses=4 --looponfail --maxfail=1
# the same thing, succinctly:
pytest -n 4 -f --maxfail=1

Run in one thread, with color and desktop notifications:

cd venv
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on eth-account failed'" ../tests ../eth_account

Release setup

For Debian-like systems:

apt install pandoc

To release a new version:

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 master branch, except when releasing a beta (in which case the beta is released from master, 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"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eth-account-0.5.3.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

eth_account-0.5.3-py3-none-any.whl (94.7 kB view details)

Uploaded Python 3

File details

Details for the file eth-account-0.5.3.tar.gz.

File metadata

  • Download URL: eth-account-0.5.3.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.9

File hashes

Hashes for eth-account-0.5.3.tar.gz
Algorithm Hash digest
SHA256 a871ec30a9afbba906174a6a7b0354045a9e90c2e90b40664c60c7739a6a6cbb
MD5 50d6bc683f2ecc6a8e0c14a1e525dcf1
BLAKE2b-256 46f582a2b1f1ff01207e988eb7fb668d45b436ce8328d8f88819c862bc5564bd

See more details on using hashes here.

File details

Details for the file eth_account-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: eth_account-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 94.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.9

File hashes

Hashes for eth_account-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 48e1476a40d1601f32d940023003c62bf5ce1ac865012df1f5b47c54d2e0be38
MD5 f2331a6186c2ad8df32e83f578d9c411
BLAKE2b-256 e6de1302c6702afc8a47f15ff8f54ef6131550cded2bd024f91c32e8cee9302e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page