Metadata-Version: 2.1
Name: 0x-web3
Version: 4.7.1.post1
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 :: 5 - Production/Stable
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
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.5.3,<4
Requires-Dist: eth-abi (<2.0.0,>=1.2.0)
Requires-Dist: eth-account (<0.4.0,>=0.2.1)
Requires-Dist: eth-utils (<2.0.0,>=1.2.0)
Requires-Dist: hexbytes (<1.0.0,>=0.1.0)
Requires-Dist: lru-dict (<2.0.0,>=1.1.6)
Requires-Dist: eth-hash[pycryptodome] (<1.0.0,>=0.2.0)
Requires-Dist: requests (<3.0.0,>=2.16.0)
Requires-Dist: websockets (<7.0.0,>=6.0.0)
Requires-Dist: cytoolz (<1.0.0,>=0.9.0); implementation_name == "cpython"
Requires-Dist: toolz (<1.0.0,>=0.9.0); implementation_name == "pypy"
Requires-Dist: pypiwin32 (>=223); platform_system == "Windows"
Provides-Extra: dev
Requires-Dist: eth-tester[py-evm] (==0.1.0-beta.32); extra == 'dev'
Requires-Dist: py-geth (<3.0.0,>=2.0.1); extra == 'dev'
Requires-Dist: flake8 (==3.4.1); extra == 'dev'
Requires-Dist: isort (<5,>=4.2.15); extra == 'dev'
Requires-Dist: mock; extra == 'dev'
Requires-Dist: sphinx-better-theme (>=0.1.4); extra == 'dev'
Requires-Dist: click (>=5.1); extra == 'dev'
Requires-Dist: configparser (==3.5.0); extra == 'dev'
Requires-Dist: contextlib2 (>=0.5.4); extra == 'dev'
Requires-Dist: ethtoken; extra == 'dev'
Requires-Dist: py-geth (>=1.4.0); extra == 'dev'
Requires-Dist: py-solc (>=0.4.0); extra == 'dev'
Requires-Dist: pytest (>=2.7.2); extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (>=0.1.9); extra == 'dev'
Requires-Dist: toposort (>=1.4); extra == 'dev'
Requires-Dist: urllib3; extra == 'dev'
Requires-Dist: web3 (>=2.1.0); extra == 'dev'
Requires-Dist: wheel; extra == 'dev'
Requires-Dist: bumpversion; extra == 'dev'
Requires-Dist: flaky (>=3.3.0); extra == 'dev'
Requires-Dist: hypothesis (>=3.31.2); extra == 'dev'
Requires-Dist: pytest (<4,>=3.5.0); extra == 'dev'
Requires-Dist: pytest-mock (==1.*); extra == 'dev'
Requires-Dist: pytest-pythonpath (>=0.3); extra == 'dev'
Requires-Dist: pytest-watch (==4.*); extra == 'dev'
Requires-Dist: pytest-xdist (==1.*); extra == 'dev'
Requires-Dist: setuptools (>=36.2.0); extra == 'dev'
Requires-Dist: tox (>=1.8.0); extra == 'dev'
Requires-Dist: tqdm; extra == 'dev'
Requires-Dist: when-changed; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mock; extra == 'docs'
Requires-Dist: sphinx-better-theme (>=0.1.4); extra == 'docs'
Requires-Dist: click (>=5.1); extra == 'docs'
Requires-Dist: configparser (==3.5.0); extra == 'docs'
Requires-Dist: contextlib2 (>=0.5.4); extra == 'docs'
Requires-Dist: ethtoken; extra == 'docs'
Requires-Dist: py-geth (>=1.4.0); extra == 'docs'
Requires-Dist: py-solc (>=0.4.0); extra == 'docs'
Requires-Dist: pytest (>=2.7.2); extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-rtd-theme (>=0.1.9); extra == 'docs'
Requires-Dist: toposort (>=1.4); extra == 'docs'
Requires-Dist: urllib3; extra == 'docs'
Requires-Dist: web3 (>=2.1.0); extra == 'docs'
Requires-Dist: wheel; extra == 'docs'
Provides-Extra: linter
Requires-Dist: flake8 (==3.4.1); extra == 'linter'
Requires-Dist: isort (<5,>=4.2.15); extra == 'linter'
Provides-Extra: tester
Requires-Dist: eth-tester[py-evm] (==0.1.0-beta.32); extra == 'tester'
Requires-Dist: py-geth (<3.0.0,>=2.0.1); extra == 'tester'
Provides-Extra: testrpc
Requires-Dist: eth-testrpc (<2.0.0,>=1.3.3); extra == 'testrpc'

0x-web3 is a temporary fork of web3. It adds primitive support for ABI
tuples, which is needed in order to facilitate calling `the 0x smart
contracts <https://0x.org/docs/contracts#Introduction>`__. The fork's
changes to web3.py are visible in `an open
PR <https://github.com/ethereum/web3.py/pull/1147>`__, and when that PR
(or something analogous) is merged, this package will be taken down.

Web3.py
=======

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

|Build Status|

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

-  Python 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(abi=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
    abi = contract_interface['abi']
    contract_instance = w3.eth.contract(address=contract_address, abi=abi,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
---------------

.. code:: sh

    git clone git@github.com:ethereum/web3.py.git
    cd web3.py

Please see OS-specific instructions for:

-  `Linux <docs/README-linux.md#Developer-Setup>`__
-  `Mac <docs/README-osx.md#Developer-Setup>`__
-  `Windows <docs/README-windows.md#Developer-Setup>`__
-  `FreeBSD <docs/README-freebsd.md#Developer-Setup>`__

Then run these install commands:

.. code:: sh

    virtualenv venv
    . venv/bin/activate
    pip install -e .[dev]

For different environments, you can set up multiple ``virtualenv``. For
example, if you want to create a ``venvdocs``, then you do the
following:

.. code:: sh

    virtualenv venvdocs
    . venvdocs/bin/activate
    pip install -e .[docs]
    pip install -e .

Using Docker
------------

If you would like to develop and test inside a Docker environment, use
the *sandbox* container provided in the **docker-compose.yml** file.

To start up the test environment, run:

::

    docker-compose up -d

This will build a Docker container set up with an environment to run the
Python test code.

**Note: This container does not have ``go-ethereum`` installed, so you
cannot run the go-ethereum test suite.**

To run the Python tests from your local machine:

::

    docker-compose exec sandbox bash -c 'pytest -n 4 -f -k "not goethereum"'

You can run arbitrary commands inside the Docker container by using the
``bash -c`` prefix.

::

    docker-compose exec sandbox bash -c ''

Or, if you would like to just open a session to the container, run:

::

    docker-compose exec sandbox bash

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 web3/ tests/ ens/ -c "clear; flake8 web3 tests ens && echo 'flake8 success' || echo 'error'"

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

Or, you can 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

How to Execute the Tests?
^^^^^^^^^^^^^^^^^^^^^^^^^

1. `Setup your development
   environment <https://github.com/ethereum/web3.py/#developer-setup>`__.

2. Execute ``tox`` for the tests

There are multiple
`components <https://github.com/ethereum/web3.py/blob/master/.travis.yml#L53>`__
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-core

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

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

    py.test tests/core/gas-strategies/test_time_based_gas_price_strategy.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"``

.. |Join the chat at https://gitter.im/ethereum/web3.py| image:: https://badges.gitter.im/ethereum/web3.py.svg
   :target: https://gitter.im/ethereum/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |Build Status| image:: https://circleci.com/gh/ethereum/web3.py.svg?style=shield
   :target: https://circleci.com/gh/ethereum/web3.py.svg?style=shield


