Web3.py
Project description
# Web3.py
[](https://gitter.im/pipermerriam/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/pipermerriam/web3.py)
[Documentation on ReadTheDocs](http://web3py.readthedocs.io/)
A python implementation of [web3.js](https://github.com/ethereum/web3.js)
* Python 2.7, 3.4, 3.5 support
* Largely feature-for-feature python implementation of Web3.js
## Installation
```sh
pip install web3
```
### Testing
For testing you can use the `TestRPCProvider`. This depends on
`eth-testrpc>=0.8.4` which must be installed independently (It is not included
as a hard dependency for this package.)
```python
from web3 import Web3, TestRPCProvider
# Initialising a Web3 instance with an RPCProvider:
web3rpc = Web3(TestRPCProvider())
# or specifying host and port.
web3rpc = Web3(TestRPCProvider(host="127.0.0.1", port="8545"))
```
The `TestRPCProvider` uses an EVM backed by the `ethereum.tester` module from
the `pyethereum` package. This can be quite useful for testing your code which
uses `web3.py`.
### Setting defaults
```python
web3.eth.defaultAccount = <your (unlocked) account>
web3.eth.defaultBlock = "latest"
# Can also be an integer or one of "latest", "pending", "earliest"
```
### Interacting with contracts
```python
>>> abi = json.joads("<abi-json-string>")
>>> ContractFactory = web3.eth.contract(abi, code="0x...")
>>> ContractFactory.deploy()
... '0x461e829a731d96539ec1f147232f1d52b475225ed343e5853ff6bf3b237c6e79'
>>> contract = web3.eth.contract(abi, address="0x...")
>>> contract.transact().someMethod()
... '0xfbb0f76aa6a6bb8d178bc2b54de8fc7ca778d704af47d135c188ca7b5d25f2e4'
>>> contract.call().return13()
... 13
>>> contract.estimateGas().someMethod()
... 23212
```
You can listen for events using the `on` and `pastEvents` functions on a
contract.
```python
def transfer_callback(log_entry):
... # do something with the log.
# create a filter and register a callback.
filter = MyContract.on("Transfer", {})
filter.watch(transfer_callback)
filter.stop_watching()
```
> The underlying asynchronous operations are managed by `gevent`.
### Timeouts, blocking and nonblocking requests
Web3.py does not currently support asynchronous calling patterns.
[](https://gitter.im/pipermerriam/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/pipermerriam/web3.py)
[Documentation on ReadTheDocs](http://web3py.readthedocs.io/)
A python implementation of [web3.js](https://github.com/ethereum/web3.js)
* Python 2.7, 3.4, 3.5 support
* Largely feature-for-feature python implementation of Web3.js
## Installation
```sh
pip install web3
```
### Testing
For testing you can use the `TestRPCProvider`. This depends on
`eth-testrpc>=0.8.4` which must be installed independently (It is not included
as a hard dependency for this package.)
```python
from web3 import Web3, TestRPCProvider
# Initialising a Web3 instance with an RPCProvider:
web3rpc = Web3(TestRPCProvider())
# or specifying host and port.
web3rpc = Web3(TestRPCProvider(host="127.0.0.1", port="8545"))
```
The `TestRPCProvider` uses an EVM backed by the `ethereum.tester` module from
the `pyethereum` package. This can be quite useful for testing your code which
uses `web3.py`.
### Setting defaults
```python
web3.eth.defaultAccount = <your (unlocked) account>
web3.eth.defaultBlock = "latest"
# Can also be an integer or one of "latest", "pending", "earliest"
```
### Interacting with contracts
```python
>>> abi = json.joads("<abi-json-string>")
>>> ContractFactory = web3.eth.contract(abi, code="0x...")
>>> ContractFactory.deploy()
... '0x461e829a731d96539ec1f147232f1d52b475225ed343e5853ff6bf3b237c6e79'
>>> contract = web3.eth.contract(abi, address="0x...")
>>> contract.transact().someMethod()
... '0xfbb0f76aa6a6bb8d178bc2b54de8fc7ca778d704af47d135c188ca7b5d25f2e4'
>>> contract.call().return13()
... 13
>>> contract.estimateGas().someMethod()
... 23212
```
You can listen for events using the `on` and `pastEvents` functions on a
contract.
```python
def transfer_callback(log_entry):
... # do something with the log.
# create a filter and register a callback.
filter = MyContract.on("Transfer", {})
filter.watch(transfer_callback)
filter.stop_watching()
```
> The underlying asynchronous operations are managed by `gevent`.
### Timeouts, blocking and nonblocking requests
Web3.py does not currently support asynchronous calling patterns.
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-3.1.0.tar.gz
(31.0 kB
view details)
Built Distribution
web3-3.1.0-py3-none-any.whl
(40.5 kB
view details)
File details
Details for the file web3-3.1.0.tar.gz.
File metadata
- Download URL: web3-3.1.0.tar.gz
- Upload date:
- Size: 31.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 20c8da225a21d4d50b5073a9491419b1d90a7a0c1b66b90927aabaa132bc4c62 |
|
| MD5 | a0c46654234ad463a7c25a24f8a5a36b |
|
| BLAKE2b-256 | 08957b1233a1b7992c4ecef063b39873ddcba4bf30da44350e54718c7c7cad66 |
File details
Details for the file web3-3.1.0-py3-none-any.whl.
File metadata
- Download URL: web3-3.1.0-py3-none-any.whl
- Upload date:
- Size: 40.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bd631b7ce7c9a6652d3b883aef0476de8e7293f77995dd59b59f493469e9fa0a |
|
| MD5 | 5895b56fb390e09f6602884d57624d00 |
|
| BLAKE2b-256 | 42bbec67c320ee87b30734d9bf717e6a931e0240ec5ab2088501e1dcf7999aec |
