Skip to main content

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
  • 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

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.

Metadata

Release files for eth-brownie 1.6.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eth-brownie 1.6.8
File Size Uploaded Provenance Actions
eth-brownie-1.6.8.tar.gz 104.3 kB Without provenance Details for eth-brownie-1.6.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for eth-brownie 1.6.8
File Interpreter ABI Platform Actions
eth_brownie-1.6.8-py3-none-any.whl Python 3 none any Details for eth_brownie-1.6.8-py3-none-any.whl

Total release size: 235.1 kB

Release files / eth-brownie-1.6.8.tar.gz

Download URL eth-brownie-1.6.8.tar.gz
Size 104.3 kB
Tags Source
SHA-256 checksum
How to use checksums
68384abe350916ba3c3c05038227d0acb628a025820e8b633edf49c6b7925eef
BLAKE2b-256 checksum
How to use checksums
4433f30597782687f4c755f557442602372ada8c1136ec1a8897a33de28395bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

Release files / eth_brownie-1.6.8-py3-none-any.whl

Download URL eth_brownie-1.6.8-py3-none-any.whl
Size 130.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e78ff93c17d58ed3aaf17b4d723fa913bd7ae42bcb2f61069700db8360df5044
BLAKE2b-256 checksum
How to use checksums
6d6ebee24c178b6b6740d8d0bb2325c31c177dee736c1367372cd9e29d93ab77
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

Security for eth-brownie 1.6.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.6.8 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page