Skip to main content

Web3.py

Project description

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

Build Status

A Python implementation of web3.js

  • Python 2.7, 3.4, 3.5 support

Read more in the documentation on ReadTheDocs. View the change log on Github.

Quickstart

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:

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

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

Docs

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:

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

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:

# 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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

web3-4.0.0b1.tar.gz (74.7 kB view details)

Uploaded Source

Built Distribution

web3-4.0.0b1-py3-none-any.whl (96.5 kB view details)

Uploaded Python 3

File details

Details for the file web3-4.0.0b1.tar.gz.

File metadata

  • Download URL: web3-4.0.0b1.tar.gz
  • Upload date:
  • Size: 74.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for web3-4.0.0b1.tar.gz
Algorithm Hash digest
SHA256 56cd96038f50441723ef2fe83d0b8a077dbdf1863fc16d4f6ca01d9643a57d7e
MD5 641b19ed2a25896ff6b031026f29eef6
BLAKE2b-256 8d503a9ca48d48835fe2ba0d53b38a79d1eb44299acb9d43dc6241d24c9b6419

See more details on using hashes here.

File details

Details for the file web3-4.0.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for web3-4.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 d2445d6b21ba9608ac6284cc796b66c127fc3b764dc09cfd7784cba7777ad5c8
MD5 e46ab21e51b5f34cfbbc58448743cfd4
BLAKE2b-256 bd1f81d11d475336c2141308a93543e7550e2417278f3518bccc160bbec3b17b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page