Easy to use Vyper debugger | vdb (https://github.com/ethereum/vyper)
Go to file
Jason Carver 1091971637 remove old merge code from circle template 2018-05-15 12:09:51 -07:00
.circleci remove old merge code from circle template 2018-05-15 12:09:51 -07:00
.github add github templates for issues and pull requests 2018-01-25 15:51:14 -08:00
docs add doctest by default 2018-02-07 11:14:11 -08:00
tests/core silence flake8 error during module import test 2018-02-06 16:10:25 -08:00
.bumpversion.cfg init 2018-01-24 16:00:28 -08:00
.gitignore fix gitignore typo about internals module in docs/ 2018-04-25 18:50:01 -07:00
.travis.yml travis config: use latest pypy3 container 2018-02-20 18:10:30 -08:00
LICENSE init 2018-01-24 16:00:28 -08:00
Makefile Makefile: deploy to upstream 2018-02-28 10:29:45 -08:00
README.md Remove duplicate python version mention in readme 2018-04-25 15:39:52 -07:00
fill_template_vars.sh keep template filler around for future merges 2018-04-25 15:20:03 -07:00
pytest.ini fixups: rm template filler, xfail strict, make bug 2018-02-01 13:07:33 -08:00
requirements-docs.txt requirements.txt: best way to build on readthedocs 2018-01-30 15:17:03 -08:00
setup.py require python 3.5 during setup (and reject py4) 2018-04-10 10:16:17 -07:00
tox.ini tox.ini bugfix: whitelist make 2018-02-07 14:40:01 -08:00

README.md

<PROJECT_NAME>

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

<SHORT_DESCRIPTION>

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

Quickstart

pip install <PYPI_NAME>

Developer setup

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

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"