Brownie
Brownie is a Python framework for deploying, testing and interacting with Ethereum smart contracts.
Dependencies
- ganache-cli - tested with version 6.7.0
- pip
- python3 version 3.6 or greater, python3-dev, python3-tk
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.
1 maintainer
Metadata
1 maintainer
Release files for eth-brownie 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| eth-brownie-1.3.0.tar.gz | 78.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| eth_brownie-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 176.0 kB
Release files / eth-brownie-1.3.0.tar.gz
| Download URL | eth-brownie-1.3.0.tar.gz |
|---|---|
| Size | 78.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db8a5508eb4310df697da4ed5b716f84e035660d1c2d93bf69d92b5af7faf809
|
|
BLAKE2b-256 checksum How to use checksums |
f14d143bf2b16867dd87a9a09ac2fb7e77707452b0eaea517651eb085278c71b
|
| 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/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.5
|
Release files / eth_brownie-1.3.0-py3-none-any.whl
| Download URL | eth_brownie-1.3.0-py3-none-any.whl |
|---|---|
| Size | 97.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d62d18f7f7f178c5625584278c167bf566d97f92f4bb9f61cf1929dece9aa614
|
|
BLAKE2b-256 checksum How to use checksums |
64cd346917b33843d339f4fd12b35b189eafa719418482e3979596c2d4a41a56
|
| 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/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.5
|
