init

README.md

@@ -0,0 +1,84 @@
+# <PROJECT_NAME>
+
+[![Join the chat at https://gitter.im/ethereum/<REPO_NAME>](https://badges.gitter.im/ethereum/<REPO_NAME>.svg)](https://gitter.im/ethereum/<REPO_NAME>?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[![Build Status](https://travis-ci.org/ethereum/<REPO_NAME>.png)](https://travis-ci.org/ethereum/<REPO_NAME>)
+   
+
+<SHORT_DESCRIPTION>
+
+* Python 3.5+ support
+
+Read more in the [documentation on ReadTheDocs](http://<RTD_NAME>.readthedocs.io/). [View the change log on Github](docs/releases.rst).
+
+## Quickstart
+
+```sh
+pip install <PYPI_NAME>
+```
+
+## Developer setup
+
+If you would like to hack on <REPO_NAME>, set up your dev environment with:
+
+```sh
+
+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:
+
+```sh
+# 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:
+
+```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 <REPO_NAME> failed'" ../tests ../<MODULE_NAME>
+```
+
+### 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`.
+
+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"`