Veriteos Web3.py
Project description
# Web3.py
[![Join the chat at https://gitter.im/ethereum/web3.py](https://badges.gitter.im/ethereum/web3.py.svg)](https://gitter.im/ethereum/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://circleci.com/gh/ethereum/web3.py.svg?style=shield)](https://circleci.com/gh/ethereum/web3.py.svg?style=shield)
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
```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
```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:
```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:
```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:
```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:
```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:
```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:
```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:
```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:
```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](https://badges.gitter.im/ethereum/web3.py.svg)](https://gitter.im/ethereum/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://circleci.com/gh/ethereum/web3.py.svg?style=shield)](https://circleci.com/gh/ethereum/web3.py.svg?style=shield)
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
```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
```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:
```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:
```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:
```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:
```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:
```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:
```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:
```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:
```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"`
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
veriteos-web3-4.7.1.post7.tar.gz
(304.4 kB
view hashes)
Built Distribution
Close
Hashes for veriteos-web3-4.7.1.post7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23e04a8625b65c5023f4aae42848f469b58094218937745d0bb92d1f03541694 |
|
MD5 | 5fb8a9f8a736c45fbe1c580bf4ca57d4 |
|
BLAKE2b-256 | e4eb858f2942f8969523cb5cd955fc2ab5387e793beb49dc25b01746a0bd3ef4 |
Close
Hashes for veriteos_web3-4.7.1.post7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5fda9f04596c686e1d328cb074399b40b24e1a0b999db6b98bdb45e7a7d9897 |
|
MD5 | c1a4122b70d430b543106ab4d5d35ae2 |
|
BLAKE2b-256 | 6f0b04e91e8da53d84b2cbd3c2b84beda70b909ee7ec0537fc801483ea5df53a |