Metadata-Version: 2.0
Name: web3
Version: 4.0.0b1
Summary: Web3.py
Home-page: https://github.com/pipermerriam/web3.py
Author: Piper Merriam
Author-email: pipermerriam@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Keywords: ethereum
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: cytoolz (>=0.8.2)
Requires-Dist: ethereum-abi-utils (>=0.4.3)
Requires-Dist: ethereum-keyfile (>=0.3.0)
Requires-Dist: ethereum-keys (>=0.1.0-alpha.7)
Requires-Dist: ethereum-utils (>=0.5.0)
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)
Requires-Dist: ethereum-tester (~=0.1.0b1)
Provides-Extra: tester
Requires-Dist: eth-testrpc (>=1.3.3); 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>`__.

Quickstart
----------

.. code:: python

    import json
    import web3

    from web3 import Web3, HTTPProvider, TestRPCProvider
    from solc import compile_source
    from web3.contract import ConciseContract

    # Solidity source code
    contract_source_code = '''
    pragma solidity ^0.4.0;

    contract Greeter {
        string public greeting;

        function Greeter() {
            greeting = 'Hello';
        }

        function setGreeting(string _greeting) public {
            greeting = _greeting;
        }

        function greet() constant returns (string) {
            return greeting;
        }
    }
    '''

    compiled_sol = compile_source(contract_source_code) # Compiled source code
    contract_interface = compiled_sol['<stdin>:Greeter']

    # web3.py instance
    w3 = Web3(TestRPCProvider())

    # Instantiate and deploy contract
    contract = w3.eth.contract(contract_interface['abi'], bytecode=contract_interface['bin'])

    # Get transaction hash from deployed contract
    tx_hash = contract.deploy(transaction={'from': w3.eth.accounts[0], 'gas': 410000})

    # Get tx receipt to get contract address
    tx_receipt = w3.eth.getTransactionReceipt(tx_hash)
    contract_address = tx_receipt['contractAddress']

    # Contract instance in concise mode
    contract_instance = w3.eth.contract(contract_interface['abi'], contract_address, ContractFactoryClass=ConciseContract)

    # Getters + Setters for web3.eth.contract object
    print('Contract value: {}'.format(contract_instance.greet()))
    contract_instance.setGreeting('Nihao', transact={'from': w3.eth.accounts[0]})
    print('Setting value to: Nihao')
    print('Contract value: {}'.format(contract_instance.greet()))

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

*TODO* other release instructions

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


