Brownie is a Python framework for deploying, testing and interacting with Ethereum smart contracts.
- ganache-cli
- pip
- python3 version 3.6 or greater, python3-dev, python3-tk
As Brownie relies on py-solc-x, you do not need solc installed locally but you must install all required solc dependencies.
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
To set up the default folder and file structure for Brownie use:
$ brownie init
Next, type brownie --help
for basic usage information.
Brownie documentation is hosted at Read the Docs.
Tests are still under development.
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.
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.