The Python implementation of the libp2p networking stack 🐍 [under development]
Go to file
2018-01-30 11:18:16 -08:00
.github add github templates for issues and pull requests 2018-01-25 15:51:14 -08:00
docs docs cleanup: Makefile, conf, warnings 2018-01-30 11:18:16 -08:00
tests/core init 2018-01-24 16:00:28 -08:00
.bumpversion.cfg init 2018-01-24 16:00:28 -08:00
.gitignore init 2018-01-24 16:00:28 -08:00
.travis.yml init 2018-01-24 16:00:28 -08:00
fill_template_vars.sh create empty module with supplied name 2018-01-24 16:31:02 -08:00
LICENSE init 2018-01-24 16:00:28 -08:00
Makefile add make lint-roll to locally auto de-lint 2018-01-26 19:01:36 -08:00
pytest.ini init 2018-01-24 16:00:28 -08:00
README.md Link to dev tactical manual 2018-01-25 17:21:42 -08:00
setup.py start at devnum 0 so the first bump goes to 1 2018-01-24 16:35:36 -08:00
tox.ini init 2018-01-24 16:00:28 -08:00

<PROJECT_NAME>

Join the chat at https://gitter.im/ethereum/<REPO_NAME>

Build Status

<SHORT_DESCRIPTION>

  • Python 3.5+ support

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

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"