Skip to content

melnaquib/brownie

 
 

Repository files navigation

Brownie

Pypi Status Build Status Docs Status Coverage 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 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.

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.

License

This project is licensed under the MIT license.

About

A python framework for Ethereum smart contract deployment, testing and interaction.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%