Skip to content
A python framework for Ethereum smart contract deployment, testing and interaction.
Branch: master
Clone or download
iamdefinitelyahuman Update README.md
fix link to build badge
Latest commit e52d8de May 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github changelog, community standards May 7, 2019
brownie check project folder is set before replacing in errstring May 14, 2019
docs fix broken links May 15, 2019
tests first tests May 14, 2019
.gitignore add tox May 15, 2019
.travis.yml add travis May 15, 2019
CHANGELOG changelog, bump version May 13, 2019
CONTRIBUTING.md changelog, docs, bump version May 12, 2019
LICENSE Initial commit Nov 2, 2018
MANIFEST.in add manifest, update setup.py Apr 8, 2019
README.md Update README.md May 15, 2019
requirements-dev.txt add tox May 15, 2019
requirements.txt update for py-solc-x 0.4.0 May 7, 2019
setup.py changelog, bump version May 13, 2019
tox.ini add travis May 15, 2019

README.md

Brownie

Pypi Status Build Status Docs Status

Brownie is a Python framework for deploying, testing and interacting with Ethereum smart contracts.

Dependencies

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

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 py.test to run specific tests against a specific version of Python.

Contributing

Help is always appreciated! In particular, Brownie needs work in the following areas before we can comfortably take it out of beta:

  • Tests
  • More tests

Feel free to open an issue if you find a problem, or a pull request if you've solved an issue.

License

This project is licensed under the MIT license.

You can’t perform that action at this time.