Skip to main content

ethpm-cli: CLI for EthPM

Project description

Join the chat at https://gitter.im/ethereum/ethpm-cli CircleCI PyPI version Python versions Docs build

CLI for EthPM

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

Quickstart

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 git@github.com:ethereum/ethpm-cli.git
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"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ethpm-cli-0.3.0.tar.gz (36.6 kB view details)

Uploaded Source

Built Distribution

ethpm_cli-0.3.0-py3-none-any.whl (43.1 kB view details)

Uploaded Python 3

File details

Details for the file ethpm-cli-0.3.0.tar.gz.

File metadata

  • Download URL: ethpm-cli-0.3.0.tar.gz
  • Upload date:
  • Size: 36.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.0

File hashes

Hashes for ethpm-cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3065ea4cdb3600b02f25f100985c55adf56cc184280ce3c302bc76d60942dbdc
MD5 202da53c5060e68b61a1c0b2d8027f5b
BLAKE2b-256 ece68b2d26d2bddc71e8b9407a7348d57c31ce140bf0f0bfce423e8d3e66130e

See more details on using hashes here.

File details

Details for the file ethpm_cli-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: ethpm_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 43.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.0

File hashes

Hashes for ethpm_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b577925b07a102bf1baf4ed4370c229c8d0724b1b22cc49a7e82a93b26954365
MD5 b92642ba4d9cecd8f60bf3db03b05c99
BLAKE2b-256 ef48b10845923f648033934711cbbf1b27f4b9d1bf2756527373cabc6dfa082a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page