forked from ethereum/eth-abi
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
remove outdated sections of README (ethereum#76)
* remove gitter, testing setup, and pandoc sections, add quotes to dev install
- Loading branch information
Showing
1 changed file
with
1 addition
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
# <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://circleci.com/gh/ethereum/<REPO_NAME>.svg?style=shield)](https://circleci.com/gh/ethereum/<REPO_NAME>) | ||
[![PyPI version](https://badge.fury.io/py/<PYPI_NAME>.svg)](https://badge.fury.io/py/<PYPI_NAME>) | ||
[![Python versions](https://img.shields.io/pypi/pyversions/<PYPI_NAME>.svg)](https://pypi.python.org/pypi/<PYPI_NAME>) | ||
|
@@ -37,43 +36,11 @@ git clone [email protected]: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> | ||
pip install -e ".[dev]" | ||
``` | ||
|
||
### Release setup | ||
|
||
For Debian-like systems: | ||
``` | ||
apt install pandoc | ||
``` | ||
|
||
To release a new version: | ||
|
||
```sh | ||
|