Metadata-Version: 2.0
Name: web3
Version: 3.16.4
Summary: Web3.py
Home-page: https://github.com/ethereum/web3.py
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 :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: cytoolz (>=0.8.2)
Requires-Dist: eth-abi (>=0.5.0)
Requires-Dist: eth-keyfile (>=0.4.0)
Requires-Dist: eth-keys (>=0.1.0-beta.3)
Requires-Dist: eth-tester (~=0.1.0b2)
Requires-Dist: eth-utils (>=0.7.1)
Requires-Dist: pylru (>=1.0.9)
Requires-Dist: pysha3 (>=0.3)
Requires-Dist: requests (>=2.12.4)
Requires-Dist: rlp (>=0.4.7)
Requires-Dist: toolz (>=0.8.2)
Provides-Extra: gevent
Requires-Dist: gevent (<1.2.0,>=1.1.1); extra == 'gevent'
Requires-Dist: geventhttpclient (>=1.3.1); extra == 'gevent'
Provides-Extra: platform_system=="Windows"
Requires-Dist: pypiwin32; extra == 'platform_system=="Windows"'
Provides-Extra: tester
Requires-Dist: eth-testrpc (>=1.2.0); extra == 'tester'

Web3.py
=======

|Join the chat at https://gitter.im/pipermerriam/web3.py|

|Build Status|

A Python implementation of
`web3.js <https://github.com/ethereum/web3.js>`__

-  Python 2.7, 3.4, 3.5 support

Read more in the `documentation on
ReadTheDocs <http://web3py.readthedocs.io/>`__. `View the change log on
Github <docs/releases.rst>`__.

Developer setup
---------------

If you would like to hack on web3.py, set up your dev environment with:

.. code:: sh

    sudo apt-get install libssl-dev
    # ^ This is for Debian-like systems. TODO: Add more platforms

    git clone git@github.com:pipermerriam/web3.py.git
    cd web3.py
    virtualenv venv
    . venv/bin/activate
    pip install -r requirements-dev.txt
    pip install -e .

For different environments, you can set up multiple virtualenvs, like:

**Python 2**

.. code:: sh

    virtualenv -p python2 venvpy2
    . venvpy2/bin/activate
    pip install -r requirements-dev.txt
    pip install -e .

**Docs**

.. code:: sh

    virtualenv venvdocs
    . venvdocs/bin/activate
    pip install -r requirements-dev.txt
    pip install -e .

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 -r web3/ tests/ -c "clear; git diff HEAD^ | flake8 --diff"

You can use pytest-watch, running one for every python environment:

.. code:: sh

    pip install pytest-watch

    cd venv
    ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on web3.py failed'" ../tests ../web3

    #in a new console
    cd venvpy2
    ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 2 test on web3.py failed'" ../tests ../web3

Or, you can run multi-process tests in one command, but without color:

.. code:: sh

    # in the project root:
    py.test --numprocesses=4 --looponfail --maxfail=1
    # the same thing, succinctly:
    pytest -n 4 -f --maxfail=1

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

.. |Join the chat at https://gitter.im/pipermerriam/web3.py| image:: https://badges.gitter.im/pipermerriam/web3.py.svg
   :target: https://gitter.im/pipermerriam/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |Build Status| image:: https://travis-ci.org/pipermerriam/web3.py.png
   :target: https://travis-ci.org/pipermerriam/web3.py


