Skip to main content

Py-EthPM

Join the chat at https://gitter.im/ethpm/lobby CircleCI PyPI version

A Python implementation of the Ethereum Package Manager Specification.

Read more in the documentation on ReadTheDocs.

WARNING!

Py-EthPM is currently in public alpha. Keep in mind: - It is expected to have bugs and is not meant to be used in production - Things may be ridiculously slow or not work at all

Quickstart

pip install ethpm

Developer Setup

If you would like to hack on Py-EthPM, please check out the Ethereum Development Tactical Manual for information on how we do:

  • Testing

  • Pull Requests

  • Code Style

  • Documentation

Developer Environment Setup

You can set up your dev environment with:

git clone git@github.com:ethpm/py-ethpm.git
cd py-ethpm
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 py-ethpm/ tests/ -c "clear; flake8 py-ethpm 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>

How to Execute the Tests?

  1. Setup your development environment.

  2. Execute tox for the tests

There are multiple components of the tests. You can run test to against specific component. For example:

# Run Tests for the Core component (for Python 3.5):
tox -e py35

# Run Tests for the Core component (for Python 3.6):
tox -e py36

If for some reason it is not working, add --recreate params.

tox is good for testing against the full set of build targets. But if you want to run the tests individually, py.test is better for development workflow. For example, to run only the tests in one file:

pytest tests/ethpm/utils/test_uri_utils.py

IPFS integration tests (tests/ethpm/integration/) require a direct connection to an IPFS node and are skipped by default (except in CircleCI, where they are run). To include these tests in your test run, first start an IPFS node and then add --integration to the pytest command.

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"

EthPM-Spec

  • EthPM-Spec <https://github.com/ethpm/ethpm-spec>__ is referenced inside this repo as a submodule.**

  • If you clone this repository, run this command to fetch the contents of the submodule

git submodule init

Metadata

Release files for ethpm 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ethpm 0.1.3
File Size Uploaded
ethpm-0.1.3.tar.gz 30.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ethpm 0.1.3
File Interpreter ABI Platform
ethpm-0.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 66.0 kB

Release files / ethpm-0.1.3.tar.gz

Download URL ethpm-0.1.3.tar.gz
Size 30.4 kB
Tags Source
SHA-256 checksum
How to use checksums
576639608101f202a0ea52f59a4078f41a7fa93906bc9cbca7ecf92075bd5700
BLAKE2b-256 checksum
How to use checksums
546d6dc5139cfdf33c0861f16599e41a22155f87f5fa935e2972dc97c33fab93
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.6

Release files / ethpm-0.1.3-py3-none-any.whl

Download URL ethpm-0.1.3-py3-none-any.whl
Size 35.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a71c0319d4fda3d2acab4cdfbe0b3a2f5b6f81c78f2a2a307383be3515dd5cad
BLAKE2b-256 checksum
How to use checksums
a664fad8528a7f76b560a460e5dfc2cd0b66ce5ec44802c66f24d565033766d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.6

Release history Release notifications | RSS feed

This release

0.1.3 This release

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page