Metadata-Version: 2.1
Name: ethpm
Version: 0.1.0a31
Summary: Python abstraction for ERC190 packages.
Home-page: https://github.com/ethpm/py-ethpm
Author: Piper Merriam
Author-email: pipermerriam@gmail.com
License: MIT
Keywords: ethereum
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Python: >=3.5, <4
Requires-Dist: toolz (<1.0.0,>=0.9.0)
Requires-Dist: cytoolz (<1.0.0,>=0.9.0)
Requires-Dist: bumpversion (<1,>=0.5.3)
Requires-Dist: eth-keys (<1,>=0.2.0b3)
Requires-Dist: eth-tester[py-evm] (==0.1.0-beta.26)
Requires-Dist: eth-utils (<2,>=1.0.2)
Requires-Dist: jsonschema (<3,>=2.6.0)
Requires-Dist: py-solc (<3,>=2.1.0)
Requires-Dist: rlp (<2,>=1.0.1)
Requires-Dist: web3 (<5,>=4.2.1)
Provides-Extra: dev
Requires-Dist: pytest-watch (<5,>=4.1.0); extra == 'dev'
Requires-Dist: pytest (<4,>=3.2.1); extra == 'dev'
Requires-Dist: requests-mock (<2,>=1.5.0); extra == 'dev'
Requires-Dist: tox (<2,>=1.8.0); extra == 'dev'
Requires-Dist: black (<19,>=18.6b4); extra == 'dev'
Requires-Dist: isort (<5,>=4.2.15); extra == 'dev'
Requires-Dist: flake8 (<4,>=3.5.0); extra == 'dev'
Requires-Dist: mypy (<0.600); extra == 'dev'
Requires-Dist: Sphinx (<2,>=1.5.5); extra == 'dev'
Requires-Dist: sphinx-rtd-theme (<2,>=0.1.9); extra == 'dev'
Provides-Extra: doc
Requires-Dist: Sphinx (<2,>=1.5.5); extra == 'doc'
Requires-Dist: sphinx-rtd-theme (<2,>=0.1.9); extra == 'doc'
Provides-Extra: lint
Requires-Dist: black (<19,>=18.6b4); extra == 'lint'
Requires-Dist: isort (<5,>=4.2.15); extra == 'lint'
Requires-Dist: flake8 (<4,>=3.5.0); extra == 'lint'
Requires-Dist: mypy (<0.600); extra == 'lint'
Provides-Extra: test
Requires-Dist: pytest (<4,>=3.2.1); extra == 'test'
Requires-Dist: requests-mock (<2,>=1.5.0); extra == 'test'
Requires-Dist: tox (<2,>=1.8.0); extra == 'test'

Py-EthPM
========

`Join the chat at
https://gitter.im/ethpm/lobby <https://gitter.im/ethpm/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge>`__
`CircleCI <https://circleci.com/gh/ethpm/py-ethpm>`__ `PyPI
version <https://badge.fury.io/py/ethpm>`__

A Python implementation of the `Ethereum Package Manager
Specification <http://ethpm.github.io/ethpm-spec/package-spec.html>`__.

Read more in the documentation on
`ReadTheDocs <https://py-ethpm.readthedocs.io/en/latest/>`__.

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

.. code:: sh

   pip install ethpm

Developer Setup
---------------

If you would like to hack on Py-EthPM, please check out the `Ethereum
Development Tactical
Manual <https://github.com/pipermerriam/ethereum-dev-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:

.. code:: sh

   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:

.. code:: sh

   # 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:

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

.. code:: sh

   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 <https://github.com/ethpm/py-ethpm/#developer-setup>`__.

2. Execute ``tox`` for the tests

There are multiple
`components <https://github.com/ethpm/py-ethpm/blob/master/.circleci/.config.yml#L56>`__
of the tests. You can run test to against specific component. For
example:

.. code:: sh

   # 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:

.. code:: sh

   pytest tests/ethpm/utils/test_uri_utils.py

Release setup
~~~~~~~~~~~~~

For Debian-like systems:

::

   apt install pandoc

To release a new version:

.. code:: sh

   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"``


