eth-typing

Common type annotations for ethereum python packages.

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

Quickstart

sh 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:

sh git clone [email protected]: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:

```sh

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:

```sh

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:

sh 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:

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

Issues

Add CI testing against dev install

opened on 2023-03-08 17:57:38 by kclowes

What was wrong?

Sometimes we run into issues because the dev dependencies won't install with the latest python versions we support. We should add a test for the dev dependency install against all python versions to make sure everything will install.

How can it be fixed?

Add a test similar to the wheel install in web3.py: https://github.com/ethereum/web3.py/blob/master/tox.ini#L75-L88 and run on CI.

Add tests to release tarball (in PyPI)

opened on 2018-09-11 14:07:57 by jluttine

Could you include tests in the source tarball in PyPI? I think it's good practice:

• https://docs.python.org/2/distutils/sourcedist.html#specifying-the-files-to-distribute
• https://stackoverflow.com/a/20180000

This way one can run the tests after installing the package. Also, I'm currently packaging this for a Linux distro, and it would be really helpful to be able to run the tests as a part of the automatic package building process while using PyPI for the release tarballs.

(See also https://github.com/ethereum/eth-utils/issues/130)