Skip to main content

eth-typing

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"

Metadata

Release files for eth-typing 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eth-typing 1.0.0
File Size Uploaded
eth-typing-1.0.0.tar.gz 3.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for eth-typing 1.0.0
File Interpreter ABI Platform
eth_typing-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 7.4 kB

Release files / eth-typing-1.0.0.tar.gz

Download URL eth-typing-1.0.0.tar.gz
Size 3.7 kB
Tags Source
SHA-256 checksum
How to use checksums
92c71d08e03d0be019452cd50632931adb7002e65edab47c3e06f97a8251c009
BLAKE2b-256 checksum
How to use checksums
145142ffb2cd2f0337e28078ccee1de5d2da09f884ab4192046cbf0828fadd49
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / eth_typing-1.0.0-py3-none-any.whl

Download URL eth_typing-1.0.0-py3-none-any.whl
Size 3.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0efd2371b9c3922620bcae1fd3264b5bf82bf1d19fcb921a61445cc49308a069
BLAKE2b-256 checksum
How to use checksums
047fdcc726fb614613a699f23583ee49c007621244a50f9f5eb919f6de70274f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page