A Python framework for Ethereum smart contract deployment, testing and interaction.
Project description
Brownie
Brownie is a Python-based development and testing framework for smart contracts targeting the Ethereum Virtual Machine.
Features
- Full support for Solidity (
>=0.4.22) and Vyper (0.1.0-b16) - Contract testing via pytest, including trace-based coverage evaluation
- Powerful debugging tools, including python-style tracebacks and custom error strings
- Built-in console for quick project interaction
- Support for ethPM packages
Dependencies
- ganache-cli - tested with version 6.7.0
- pip
- python3 version 3.6 or greater, python3-dev
As Brownie relies on py-solc-x, you do not need solc installed locally but you must install all required solc dependencies.
Installation
You can install the latest release via pip:
pip install eth-brownie
Or clone the repository and use setuptools for the most up-to-date version:
python3 setup.py install
Quick Usage
To set up the default folder and file structure for Brownie use:
brownie init
Next, type brownie --help for basic usage information.
Documentation
Brownie documentation is hosted at Read the Docs.
Testing
To run the tests, first install the developer dependencies:
pip install -r requirements-dev.txt
Then use tox to run the complete suite against the full set of build targets, or pytest to run tests against a specific version of Python. If you are using pytest you must include the -p no:pytest-brownie flag to prevent it from loading the Brownie plugin.
Using Docker
You can use a sandbox container provided in the docker-compose.yml file for testing inside a Docker environment.
This container provides everything you need to test using a Python 3.6 interpreter.
Start the test environment:
docker-compose up -d
To open a session to the container:
docker-compose exec sandbox bash
To run arbitrary commands, use the bash -c prefix.
docker-compose exec sandbox bash -c ''
For example, to run the tests in brownie/tests/test_format_input.py:
docker-compose exec sandbox bash -c 'python -m pytest tests/convert/test_format_input.py'
Contributing
Help is always appreciated! Feel free to open an issue if you find a problem, or a pull request if you've solved an issue.
Join the Brownie Gitter channel if you have any questions.
Pre-Commit Hooks
We use pre-commit hooks, primarily to ensure consistent formatting among contributors.
If you haven't already, install all dev dependencies in requirements-dev.txt to enable pre-commit hooks.
Install pre-commit locally from the brownie root folder:
pre-commit install
Commiting will now automatically run the local pre-commit hooks.
If, for some reason, you need to force the commit without running the pre-commit hooks, you can manually disable the pre-commit.
git commit -m "commit message" --no-verify
License
This project is licensed under the MIT license.
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
Built Distribution
File details
Details for the file eth-brownie-1.4.2.tar.gz.
File metadata
- Download URL: eth-brownie-1.4.2.tar.gz
- Upload date:
- Size: 83.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 301cd263fc10d5d86ba030a7ed987b5b32ed4e84939b9480342ac8db715c5d29 |
|
| MD5 | 96029a6df9eb5f1a899e14309643e68d |
|
| BLAKE2b-256 | bf59f1b951e539ed539ba0167d365d68b693e1b3ef1ce9ac202754f79a6b8d16 |
File details
Details for the file eth_brownie-1.4.2-py3-none-any.whl.
File metadata
- Download URL: eth_brownie-1.4.2-py3-none-any.whl
- Upload date:
- Size: 104.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 967bc3662a39e1040de3fed1f3176741171e55e066737a31dec0449acbf5111f |
|
| MD5 | ecb277b8e377c4df0717bbf2dd654293 |
|
| BLAKE2b-256 | 9447910ac2be1b90604b35749b6121af98193b85a84c7e9f401a37aa550ce0a9 |
