Skip to main content

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

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-beta.16)
  • Contract testing via pytest, including trace-based coverage evaluation
  • Property-based and stateful testing via hypothesis
  • Powerful debugging tools, including python-style tracebacks and custom error strings
  • Built-in console for quick project interaction
  • Support for ethPM packages

Dependencies

Installation

via pipx

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.

To install pipx:

python3 -m pip install --user pipx
python3 -m pipx ensurepath

To install Brownie using pipx:

pipx install eth-brownie

To upgrade to the latest version:

pipx upgrade eth-brownie

via pip

You can install the latest release via pip:

pip install eth-brownie

via setuptools

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

Quick Usage

To initialize a new Brownie project, start by creating a new folder. From within that folder, type:

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eth-brownie-1.11.5.tar.gz (146.0 kB view details)

Uploaded Source

Built Distribution

eth_brownie-1.11.5-py3-none-any.whl (174.1 kB view details)

Uploaded Python 3

File details

Details for the file eth-brownie-1.11.5.tar.gz.

File metadata

  • Download URL: eth-brownie-1.11.5.tar.gz
  • Upload date:
  • Size: 146.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

File hashes

Hashes for eth-brownie-1.11.5.tar.gz
Algorithm Hash digest
SHA256 30eaa825c9d3679123aa4bd1332d4e3301732fa548e4ff0a429623867252cf35
MD5 376d585b740eac3e1ceb3fc7c9667b0e
BLAKE2b-256 fd5edbdb0261c3b92bd3fea9999384bdff06fc56573245d1afbed9eaa4c3a4e6

See more details on using hashes here.

File details

Details for the file eth_brownie-1.11.5-py3-none-any.whl.

File metadata

  • Download URL: eth_brownie-1.11.5-py3-none-any.whl
  • Upload date:
  • Size: 174.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

File hashes

Hashes for eth_brownie-1.11.5-py3-none-any.whl
Algorithm Hash digest
SHA256 df7ef9b7d65303127268f7ef5552fb1866ff4e70ab3247469f45367a50edeca7
MD5 66669c316473fccbd923d9b2cca41836
BLAKE2b-256 7406aaf90b25dbefdce02610383c7febac89516286f429854814b84e7b318234

See more details on using hashes here.

Supported by

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