Skip to main content

eth-typing: Common type annotations for ethereum python packages

Project description

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

Common type annotations for ethereum python packages.

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

Quickstart

pip install eth-typing

Developer Setup

If you would like to hack on eth-typing, please check out the Ethereum Development 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-typing.git
cd eth-typing
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]

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_typing/ tests/ -c "clear; flake8 eth_typing 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-typing failed'" ../tests ../eth_typing

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.

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-typing-1.3.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

eth_typing-1.3.0-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file eth-typing-1.3.0.tar.gz.

File metadata

  • Download URL: eth-typing-1.3.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.0

File hashes

Hashes for eth-typing-1.3.0.tar.gz
Algorithm Hash digest
SHA256 3b4744c9026e44f3234aae48d3d18062760efc0f755f663f723a12214f127dfc
MD5 2b03f4e8edd3159bdf00075fc4e35abe
BLAKE2b-256 e88493788ba669cfcf7a16c92adcbd318482239bedb9cb0d3f71df65feb3bc0e

See more details on using hashes here.

File details

Details for the file eth_typing-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: eth_typing-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.0

File hashes

Hashes for eth_typing-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 77da8a1f2f91f248cc42493f3dea3245f23a48224a513c4fd05f48b778dafb1a
MD5 57dff0f958d3e5d9aebc305660309594
BLAKE2b-256 5fcbe941031a77d19eef05f8bcdd40f6d8a3b55b7fa45aa7100206d64216c29b

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