Brownie is a Python-based development and testing framework for smart contracts targeting the Ethereum Virtual Machine.
- Full support for Solidity (
>=0.4.22) and Vyper (
- Contract testing via
pytest, including trace-based coverage evaluation
- Property-based and stateful testing via
- Powerful debugging tools, including python-style tracebacks and custom error strings
- Built-in console for quick project interaction
- Support for ethPM packages
The recommended way to install Brownie is via
pipx. pipx installs Brownie into a virtual environment and makes it available directly from the commandline. Once installed, you will never have to activate a virtual environment prior to using Brownie.
python3 -m pip install --user pipx python3 -m pipx ensurepath
To install Brownie using
pipx install eth-brownie
To upgrade to the latest version:
pipx upgrade eth-brownie
To use lastest master or another branch as version:
pipx install git+https://github.com/eth-brownie/brownie.git@master
You can install the latest release via
pip install eth-brownie
You can clone the repository and use
setuptools for the most up-to-date version:
git clone https://github.com/eth-brownie/brownie.git cd brownie python3 setup.py install
as a library
If you want to install brownie inside your own project (rather than as a standalone cli tool):
export BROWNIE_LIB=1 pip install eth-brownie
This loosens the pins on all dependencies. You'll want to make sure you have your own
requirements.txt to make sure upgrades upstream don't surprise anyone.
There are extra tools that are helpful when developing:
git clone https://github.com/eth-brownie/brownie.git cd brownie python3 -m venv venv ./venv/bin/pip install wheel ./venv/bin/pip install -e . -r requirements-dev.txt
Upgrading the pinned versions of dependencies is easy:
./venv/bin/pip-compile --upgrade ./venv/bin/pip-compile --upgrade requirements-dev.in ./venv/bin/pip-compile --upgrade requirements-windows.in
Even small upgrades of patch versions have broken things in the past, so be sure to run all tests after upgrading things!
To initialize a new Brownie project, start by creating a new folder. From within that folder, type:
brownie --help for basic usage information.
Documentation and Support
Brownie documentation is hosted at Read the Docs.
To run the tests, first install the developer dependencies:
pip install -e . -r requirements-dev.txt
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.
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
docker-compose exec sandbox bash -c 'python -m pytest tests/convert/test_format_input.py'
Attaching to dockerized RPC clients
You can also attach to a RPC client already running inside a docker container.
For example for running ganache-cli you could just startup the official ganache-cli docker image:
docker run -p 8545:8545 trufflesuite/ganache-cli
Then in another terminal on your host you could connect to it:
If you have your RPC client bound to a specific hostname e.g.
ganache you could create a separate brownie network for it:
brownie networks add Development dev cmd=ganache-cli host=http://ganache:8545
Then connect to it with:
brownie console --network dev
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.
This project is licensed under the MIT license.