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

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.

Join the Brownie Gitter channel if you have any questions.

Pre-Commit Hooks

We use pre-commit hooks, primarily to ensure consistent formatting among contributors.

If you haven't already, install all dev dependencies in requirements-dev.txt to enable pre-commit hooks.

Install pre-commit locally from the brownie root folder:

pre-commit install

Commiting will now automatically run the local pre-commit hooks.

If, for some reason, you need to force the commit without running the pre-commit hooks, you can manually disable the pre-commit.

git commit -m "commit message" --no-verify

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.3.1.tar.gz (78.8 kB view details)

Uploaded Source

Built Distribution

eth_brownie-1.3.1-py3-none-any.whl (97.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: eth-brownie-1.3.1.tar.gz
  • Upload date:
  • Size: 78.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.5

File hashes

Hashes for eth-brownie-1.3.1.tar.gz
Algorithm Hash digest
SHA256 1e2c7ef95ba8652c3561fc8e5d2abf30b52d4703160d7e2f7aa079a28b34da48
MD5 9cbba69a1fd4c94e2440533abcbea87c
BLAKE2b-256 257c086b9c52b36aa1199e1a6deca67ccb25fbec65e701a4493e84086bd711f1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: eth_brownie-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 97.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.5

File hashes

Hashes for eth_brownie-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 40d1577fed0ee46fcd7517febd68747850d4b0d0a893e8508b143989c396aadd
MD5 70c2bfc37740ecca174e9880a440f05f
BLAKE2b-256 f720270ceb7bd6020593e08be4ed97ea5ec08b49a46385ce020481dd4f5e2552

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