🐍⚡️Support Python for everyone by grabbing a 30% discount on PyCharm—ALL proceeds go to the Python Software Foundation. Offer ends soon, so grab it today!  GET 30% OFF PYCHARM

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

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for iamdefinitelyahuman from gravatar.com iamdefinitelyahuman

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Ben Hauser
  • Tags brownie
  • Requires: Python >=3.6, <4
Classifiers
Report project as malware

Project description

Brownie

Pypi Status Build Status Docs Status Coverage Status

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

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:

python 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 and Support

Brownie documentation is hosted at Read the Docs.

If you have any questions about how to use Brownie, feel free to ask on Ethereum StackExchange or join us on Gitter.

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.

Please check out our Contribution Guide prior to opening a pull request, and join the Brownie Gitter channel if you have any questions.

License

This project is licensed under the MIT license.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page