Skip to main content

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

Project description

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). To include changes made with each release, update “docs/releases.rst” with the changes, and apply commit directly to master before release.

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.0.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

eth_account-0.5.0-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: eth-account-0.5.0.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.9

File hashes

Hashes for eth-account-0.5.0.tar.gz
Algorithm Hash digest
SHA256 819cd60a315b29c9f934b83e313fc546a4f8a8e762493297ad6e239d41e3b037
MD5 9d66d91bd869790e7242650798c279d4
BLAKE2b-256 64f852692ffd733c942bbf684f4b7b6ea910e607d4fe52d3c6bc8c9259cb2f98

See more details on using hashes here.

File details

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

File metadata

  • Download URL: eth_account-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.9

File hashes

Hashes for eth_account-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 06011ba9b5737f426e27a78f7e470db27804548ef79212724f976272a7cae1b4
MD5 b11ca3cbf613c68cd50bc3fbcd5a9cf8
BLAKE2b-256 c37fc8a0958973f953f0cfcaa4d7e75ed33e5da9c5d1ba14c405f12ea75d911b

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