Skip to main content

twig: A tool for Ethereum smart contract development.

Project description

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

A tool for Ethereum smart contract development.

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

Quickstart

pip install twig

Developer Setup

If you would like to hack on twig, 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/twig.git
cd twig
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 twig/ tests/ -c "clear; flake8 twig 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 twig failed'" ../tests ../twig

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"

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

twig-0.1.0a5.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

twig-0.1.0a5-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file twig-0.1.0a5.tar.gz.

File metadata

  • Download URL: twig-0.1.0a5.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/28.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.0

File hashes

Hashes for twig-0.1.0a5.tar.gz
Algorithm Hash digest
SHA256 0fe58c094d9b6f48fd45f5eda8f223a105227f98c31866b3afce79d685790a4e
MD5 5ec9952b4c30295aee65274ff3ee91fa
BLAKE2b-256 21a01e45c8d5b5a577c1e50118bfb8edca207abc6bdaffb45614616e8fbd71ee

See more details on using hashes here.

File details

Details for the file twig-0.1.0a5-py3-none-any.whl.

File metadata

  • Download URL: twig-0.1.0a5-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/28.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.0

File hashes

Hashes for twig-0.1.0a5-py3-none-any.whl
Algorithm Hash digest
SHA256 3ab824421267a8a4837453c26bfd4af77a9526d1947cce7804779e85551ec983
MD5 c0b1225e149305cffcf39df7a1b8fcd9
BLAKE2b-256 844bbc336e0b098380b9c7beadbc215d93648d178c7049e3ea98c23d35575307

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