vns web3.pyl
Project description
Web3.py
A Python implementation of web3.js
- Python 3.6+ support
Developer Setup
[![Join the chat at https://gitter.im/vnscoin/web3.py](https://badges.gitter.im/vnscoin/web3.py.svg)](https://gitter.im/vnscoin/web3.py?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://circleci.com/gh/vnscoin/web3.py.svg?style=shield)](https://circleci.com/gh/vnscoin/web3.py)
A Python implementation of [web3.js](https://github.com/vnscoin/web3.js)
* Python 3.6+ support
## Developer Setup
```sh
git clone git@github.com:vnscoin/web3.py.git
cd web3.py
Please see OS-specific instructions for:
Then run these install commands:
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:
virtualenv venvdocs
. venvdocs/bin/activate
pip install -e .[docs]
pip install -e .
How to Execute the Tests?
-
Execute
tox
for the tests
There are multiple components of the tests. You can run test to against specific component. For example:
# Run Tests for the Core component (for Python 3.6):
tox -e py36-core
# Run Tests for the Core component (for Python 3.7):
tox -e py37-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, pytest
is better for development workflow. For example, to run only the tests in one file:
pytest 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:
make release bump=$$VERSION_PART_TO_BUMP$$
To preview the upcoming release notes:
towncrier --draft
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"
git clone git@github.com:vnscoin/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)
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:
virtualenv venvdocs
. venvdocs/bin/activate
pip install -e .[docs]
pip install -e .
How to Execute the Tests?
-
Execute
tox
for the tests
There are multiple components of the tests. You can run test to against specific component. For example:
# Run Tests for the Core component (for Python 3.6):
tox -e py36-core
# Run Tests for the Core component (for Python 3.7):
tox -e py37-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, pytest
is better for development workflow. For example, to run only the tests in one file:
pytest 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:
make release bump=$$VERSION_PART_TO_BUMP$$
To preview the upcoming release notes:
towncrier --draft
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.