Skip to content
CLI tool for interacting with the ethPM ecosystem.
Python Shell Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github add github templates for issues and pull requests Jan 25, 2018
ethpm_cli Implement ethpm get command Nov 8, 2019
tests Implement ethpm get command Nov 8, 2019
.pydocstyle.ini Add docstring checking with pydocstyle Jan 24, 2019
.readthedocs.yml Add pip_install to .readthedocs.yml Jul 31, 2019
LICENSE Remove attribution to specific person Mar 25, 2019 Write file Jul 31, 2019
Makefile Initial commit Apr 9, 2019
pytest.ini Enhance parse_bool_flag to support invalid responses. Aug 1, 2019
requirements-docs.txt Add suggestions to docs Jul 31, 2019
tox.ini Remove cli tests from circle test env Aug 7, 2019


Join the chat at CircleCI PyPI version Python versions Docs build

CLI for EthPM

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


pip install ethpm-cli

Developer Setup

If you would like to hack on ethpm-cli, please check out the Snake Charmers 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
cd ethpm-cli
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 ethpm_cli/ tests/ -c "clear; flake8 ethpm_cli 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 ethpm-cli failed'" ../tests ../ethpm_cli

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. 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.

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"

You can’t perform that action at this time.