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.1.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.1.0
File Size Uploaded
eth-typing-3.1.0.tar.gz 6.0 kB Details

Built distribution (wheel)

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

Total release size: 12.3 kB

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

Download URL eth-typing-3.1.0.tar.gz
Size 6.0 kB
Tags Source
SHA-256 checksum
How to use checksums
92698268be83c75f65a028d47421f7c0aed459be76dd7ce916af166dca8bc53e
BLAKE2b-256 checksum
How to use checksums
b3c4cfb6a465cabb7792cb8e06487ab9e94e70d9883ee4e06c3bb1ee836d08fa
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.1.0-py3-none-any.whl

Download URL eth_typing-3.1.0-py3-none-any.whl
Size 6.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
46cd7d8b1214e059c8283b21d15e1aee375775c26ada9e1e8409e4e4c85926a8
BLAKE2b-256 checksum
How to use checksums
46ef5fab2a4e7a9976f052b117e254e8c34097408bc98925c3d001d4fc31b87c
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