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 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-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. 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"

Metadata

Release files for eth-typing 3.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 3.0.0
File Size Uploaded
eth-typing-3.0.0.tar.gz 5.4 kB Details

Built distribution (wheel)

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

Total release size: 11.7 kB

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

Download URL eth-typing-3.0.0.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
079e4c41e98cf2635d3830a99f3cbd7b1d73d2368464d4493c002bece545184a
BLAKE2b-256 checksum
How to use checksums
7b3fb4de67863e1af8550a80d0f1505ff18eb85914f3e880137c28e607713167
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.2

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

Download URL eth_typing-3.0.0-py3-none-any.whl
Size 6.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fb96f5eaa844b8be7727d590a54a952a42e5021426f98074b06b23ae43de5867
BLAKE2b-256 checksum
How to use checksums
44358c12a1bb688487e80c2a9b4c4a82679e938f765c7dd4e2e7e12e2ac6d1fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.2
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