2018-01-25 08:00:28 +08:00
# <PROJECT_NAME>
[](https://gitter.im/ethereum/< REPO_NAME > ?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2018-04-22 15:34:42 +08:00
[](https://circleci.com/gh/ethereum/< REPO_NAME > )
2018-02-07 07:33:04 +08:00
[](https://badge.fury.io/py/< PYPI_NAME > )
[](https://pypi.python.org/pypi/< PYPI_NAME > )
2018-02-07 07:42:21 +08:00
[](http://< RTD_NAME > .readthedocs.io/en/latest/?badge=latest)
2018-01-25 08:00:28 +08:00
< SHORT_DESCRIPTION >
2018-06-02 04:05:57 +08:00
Read more in the [documentation on ReadTheDocs ](https://<RTD_NAME>.readthedocs.io/ ). [View the change log ](https://<RTD_NAME>.readthedocs.io/en/latest/releases.html ).
2018-01-25 08:00:28 +08:00
## Quickstart
```sh
pip install < PYPI_NAME >
```
2018-06-02 04:05:57 +08:00
## Developer Setup
2018-01-25 08:00:28 +08:00
2019-03-26 05:14:04 +08:00
If you would like to hack on < REPO_NAME > , please check out the [Snake Charmers
Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)
2018-01-26 09:21:42 +08:00
for information on how we do:
- Testing
- Pull Requests
- Code Style
- Documentation
### Development Environment Setup
You can set up your dev environment with:
2018-01-25 08:00:28 +08:00
```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,
2018-08-28 01:15:43 +08:00
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.
2018-01-25 08:00:28 +08:00
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"`
