# Brownie
[](https://pypi.org/project/eth-brownie/) [](https://eth-brownie.readthedocs.io/en/stable/)
Brownie is a Python-based development and testing framework for smart contracts targeting the [Ethereum Virtual Machine](https://solidity.readthedocs.io/en/v0.6.0/introduction-to-smart-contracts.html#the-ethereum-virtual-machine).
**Brownie is no longer actively maintained**. Future releases may come sporadically - or never at all. Check out [Ape Framework](https://github.com/ApeWorX/ape) for all your python Ethereum development needs.
## Features
* Full support for [Solidity](https://github.com/ethereum/solidity) (`>=0.4.22`) and [Vyper](https://github.com/vyperlang/vyper) (`>=0.1.0-beta.16`)
* Contract testing via [`pytest`](https://github.com/pytest-dev/pytest), including trace-based coverage evaluation
* Property-based and stateful testing via [`hypothesis`](https://github.com/HypothesisWorks/hypothesis/tree/master/hypothesis-python)
* Powerful debugging tools, including python-style tracebacks and custom error strings
* Built-in console for quick project interaction
## Dependencies
* [python3](https://www.python.org/downloads/release/python-3910/) version 3.10 or greater, python3-dev
* [hardhat](https://github.com/NomicFoundation/hardhat) or [ganache](https://github.com/trufflesuite/ganache)
Tested with ganache version [7.9.2](https://github.com/trufflesuite/ganache/releases/tag/v7.0.2), however it is generally recommended to use hardhat because ganache has been sunsetted.
## Installation
### via `pipx`
The recommended way to install Brownie is via [`pipx`](https://github.com/pipxproject/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`:
```bash
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```
To install Brownie using `pipx`:
```bash
pipx install eth-brownie
```
To upgrade to the latest version:
```bash
pipx upgrade eth-brownie
```
To use lastest master or another branch as version:
```bash
pipx install git+https://github.com/eth-brownie/brownie.git@master
```
### via `pip`
You can install the latest release via [`pip`](https://pypi.org/project/pip/):
```bash
pip install eth-brownie
```
### via `setuptools`
You can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:
```bash
git clone https://github.com/eth-brownie/brownie.git
cd brownie
python3 setup.py install
```
### as a library
If you want to install brownie inside your own project (rather than as a standalone cli tool):
```bash
export BROWNIE_LIB=1
pip install eth-brownie
```
This loosens the pins on all dependencies. You'll want to make sure you have your own `requirements.txt` to make sure upgrades upstream don't surprise anyone.
### for development
There are extra tools that are helpful when developing:
```bash
git clone https://github.com/eth-brownie/brownie.git
cd brownie
python3 -m venv venv
./venv/bin/pip install wheel
./venv/bin/pip install -e . -r requirements-dev.txt
```
Upgrading the pinned versions of dependencies is easy:
```
./venv/bin/pip-compile --upgrade
./venv/bin/pip-compile --upgrade requirements-dev.in
./venv/bin/pip-compile --upgrade requirements-windows.in
```
Even small upgrades of patch versions have broken things in the past, so be sure to run all tests after upgrading things!
## Quick Usage
To initialize a new Brownie project, start by creating a new folder. From within that folder, type:
```bash
brownie init
```
Next, type `brownie --help` for basic usage information.
## Documentation and Support
Brownie documentation is hosted at [Read the Docs](https://eth-brownie.readthedocs.io/en/latest/).
If you have any questions about how to use Brownie, feel free to ask on [Ethereum StackExchange](https://ethereum.stackexchange.com/) or join us on [Gitter](https://gitter.im/eth-brownie/community).
## Testing
To run the tests, first install the developer dependencies:
```bash
pip install -e . -r requirements-dev.txt
```
Then use [`tox`](https://github.com/tox-dev/tox) to run the complete suite against the full set of build targets, or [`pytest`](https://github.com/pytest-dev/pytest) to run tests against a specific version of Python. If you are using [`pytest`](https://github.com/pytest-dev/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`](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:
```bash
docker-compose up -d
```
To open a session to the container:
```bash
docker-compose exec sandbox bash
```
To run arbitrary commands, use the `bash -c` prefix.
```bash
docker-compose exec sandbox bash -c ''
```
For example, to run the tests in `brownie/tests/test_format_input.py`:
```bash
docker-compose exec sandbox bash -c 'python -m pytest tests/convert/test_format_input.py'
```
#### Attaching to dockerized RPC clients
You can also attach to a RPC client already running inside a docker container.
For example for running ganache-cli you could just startup the official ganache-cli docker image:
```bash
docker run -p 8545:8545 trufflesuite/ganache-cli
```
Then in another terminal on your host you could connect to it:
```bash
brownie console
```
If you have your RPC client bound to a specific hostname e.g. `ganache` you could create a separate brownie network for it:
```bash
brownie networks add Development dev cmd=ganache-cli host=http://ganache:8545
```
Then connect to it with:
```bash
brownie console --network dev
```
## 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](CONTRIBUTING.md) prior to opening a pull request, and join the Brownie [Gitter channel](https://gitter.im/eth-brownie/community) if you have any questions.
## License
This project is licensed under the [MIT license](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/eth-brownie/brownie",
"name": "eth-brownie",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4",
"maintainer_email": "",
"keywords": "brownie",
"author": "Ben Hauser",
"author_email": "ben@hauser.id",
"download_url": "https://files.pythonhosted.org/packages/c3/69/7d066b33c02517f24e281c523919284f2e195f2242b7a1b62ffc7183aeef/eth-brownie-1.20.2.tar.gz",
"platform": null,
"description": "# Brownie\n\n[](https://pypi.org/project/eth-brownie/) [](https://eth-brownie.readthedocs.io/en/stable/)\n\nBrownie is a Python-based development and testing framework for smart contracts targeting the [Ethereum Virtual Machine](https://solidity.readthedocs.io/en/v0.6.0/introduction-to-smart-contracts.html#the-ethereum-virtual-machine).\n\n**Brownie is no longer actively maintained**. Future releases may come sporadically - or never at all. Check out [Ape Framework](https://github.com/ApeWorX/ape) for all your python Ethereum development needs.\n\n## Features\n\n* Full support for [Solidity](https://github.com/ethereum/solidity) (`>=0.4.22`) and [Vyper](https://github.com/vyperlang/vyper) (`>=0.1.0-beta.16`)\n* Contract testing via [`pytest`](https://github.com/pytest-dev/pytest), including trace-based coverage evaluation\n* Property-based and stateful testing via [`hypothesis`](https://github.com/HypothesisWorks/hypothesis/tree/master/hypothesis-python)\n* Powerful debugging tools, including python-style tracebacks and custom error strings\n* Built-in console for quick project interaction\n\n## Dependencies\n\n* [python3](https://www.python.org/downloads/release/python-3910/) version 3.10 or greater, python3-dev\n* [hardhat](https://github.com/NomicFoundation/hardhat) or [ganache](https://github.com/trufflesuite/ganache)\n\nTested with ganache version [7.9.2](https://github.com/trufflesuite/ganache/releases/tag/v7.0.2), however it is generally recommended to use hardhat because ganache has been sunsetted.\n\n## Installation\n\n### via `pipx`\n\nThe recommended way to install Brownie is via [`pipx`](https://github.com/pipxproject/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.\n\nTo install `pipx`:\n\n```bash\npython3 -m pip install --user pipx\npython3 -m pipx ensurepath\n```\n\nTo install Brownie using `pipx`:\n\n```bash\npipx install eth-brownie\n```\n\nTo upgrade to the latest version:\n\n```bash\npipx upgrade eth-brownie\n```\n\nTo use lastest master or another branch as version:\n```bash\npipx install git+https://github.com/eth-brownie/brownie.git@master\n```\n\n### via `pip`\n\nYou can install the latest release via [`pip`](https://pypi.org/project/pip/):\n\n```bash\npip install eth-brownie\n```\n\n### via `setuptools`\n\nYou can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:\n\n```bash\ngit clone https://github.com/eth-brownie/brownie.git\ncd brownie\npython3 setup.py install\n```\n\n### as a library\n\nIf you want to install brownie inside your own project (rather than as a standalone cli tool):\n\n```bash\nexport BROWNIE_LIB=1\npip install eth-brownie\n```\n\nThis loosens the pins on all dependencies. You'll want to make sure you have your own `requirements.txt` to make sure upgrades upstream don't surprise anyone.\n\n### for development\n\nThere are extra tools that are helpful when developing:\n\n```bash\ngit clone https://github.com/eth-brownie/brownie.git\ncd brownie\npython3 -m venv venv\n./venv/bin/pip install wheel\n./venv/bin/pip install -e . -r requirements-dev.txt\n```\n\nUpgrading the pinned versions of dependencies is easy:\n```\n./venv/bin/pip-compile --upgrade\n./venv/bin/pip-compile --upgrade requirements-dev.in\n./venv/bin/pip-compile --upgrade requirements-windows.in\n```\n\nEven small upgrades of patch versions have broken things in the past, so be sure to run all tests after upgrading things!\n\n## Quick Usage\n\nTo initialize a new Brownie project, start by creating a new folder. From within that folder, type:\n\n```bash\nbrownie init\n```\n\nNext, type `brownie --help` for basic usage information.\n\n## Documentation and Support\n\nBrownie documentation is hosted at [Read the Docs](https://eth-brownie.readthedocs.io/en/latest/).\n\nIf you have any questions about how to use Brownie, feel free to ask on [Ethereum StackExchange](https://ethereum.stackexchange.com/) or join us on [Gitter](https://gitter.im/eth-brownie/community).\n\n## Testing\n\nTo run the tests, first install the developer dependencies:\n\n```bash\npip install -e . -r requirements-dev.txt\n```\n\nThen use [`tox`](https://github.com/tox-dev/tox) to run the complete suite against the full set of build targets, or [`pytest`](https://github.com/pytest-dev/pytest) to run tests against a specific version of Python. If you are using [`pytest`](https://github.com/pytest-dev/pytest) you must include the `-p no:pytest-brownie` flag to prevent it from loading the Brownie plugin.\n\n### Using Docker\n\nYou can use a sandbox container provided in the [`docker-compose.yml`](docker-compose.yml) file for testing inside a Docker environment.\n\nThis container provides everything you need to test using a Python 3.6 interpreter.\n\nStart the test environment:\n\n```bash\ndocker-compose up -d\n```\n\nTo open a session to the container:\n\n```bash\ndocker-compose exec sandbox bash\n```\n\nTo run arbitrary commands, use the `bash -c` prefix.\n\n```bash\ndocker-compose exec sandbox bash -c ''\n```\n\nFor example, to run the tests in `brownie/tests/test_format_input.py`:\n\n```bash\ndocker-compose exec sandbox bash -c 'python -m pytest tests/convert/test_format_input.py'\n```\n\n#### Attaching to dockerized RPC clients\n\nYou can also attach to a RPC client already running inside a docker container.\n\nFor example for running ganache-cli you could just startup the official ganache-cli docker image:\n\n```bash\ndocker run -p 8545:8545 trufflesuite/ganache-cli\n```\n\nThen in another terminal on your host you could connect to it:\n\n```bash\nbrownie console\n```\n\nIf you have your RPC client bound to a specific hostname e.g. `ganache` you could create a separate brownie network for it:\n\n```bash\nbrownie networks add Development dev cmd=ganache-cli host=http://ganache:8545\n```\n\nThen connect to it with:\n\n```bash\nbrownie console --network dev\n```\n\n## Contributing\n\nHelp is always appreciated! Feel free to open an issue if you find a problem, or a pull request if you've solved an issue.\n\nPlease check out our [Contribution Guide](CONTRIBUTING.md) prior to opening a pull request, and join the Brownie [Gitter channel](https://gitter.im/eth-brownie/community) if you have any questions.\n\n## License\n\nThis project is licensed under the [MIT license](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python framework for Ethereum smart contract deployment, testing and interaction.",
"version": "1.20.2",
"project_urls": {
"Homepage": "https://github.com/eth-brownie/brownie"
},
"split_keywords": [
"brownie"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "330a9981a83aed673a3fbf450df6a5bec7ba6481b2adac2745fd3ab352a31bbd",
"md5": "333275faf12c11654611da995ecf2785",
"sha256": "5f280fad032e83ee5b76ada80934d1bf5d8a8b2b4aa3ecf80bbcb82f986c0477"
},
"downloads": -1,
"filename": "eth_brownie-1.20.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "333275faf12c11654611da995ecf2785",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4",
"size": 219011,
"upload_time": "2024-02-24T07:57:14",
"upload_time_iso_8601": "2024-02-24T07:57:14.062367Z",
"url": "https://files.pythonhosted.org/packages/33/0a/9981a83aed673a3fbf450df6a5bec7ba6481b2adac2745fd3ab352a31bbd/eth_brownie-1.20.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c3697d066b33c02517f24e281c523919284f2e195f2242b7a1b62ffc7183aeef",
"md5": "27263d3c84d19ccda7e46920aacef5b2",
"sha256": "7d9e2e1eccbc24d1a212acf345810298ed088b1bebea449ab65fd8a95b3f847e"
},
"downloads": -1,
"filename": "eth-brownie-1.20.2.tar.gz",
"has_sig": false,
"md5_digest": "27263d3c84d19ccda7e46920aacef5b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4",
"size": 208031,
"upload_time": "2024-02-24T07:57:17",
"upload_time_iso_8601": "2024-02-24T07:57:17.748463Z",
"url": "https://files.pythonhosted.org/packages/c3/69/7d066b33c02517f24e281c523919284f2e195f2242b7a1b62ffc7183aeef/eth-brownie-1.20.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-24 07:57:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eth-brownie",
"github_project": "brownie",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "eth-brownie"
}
JSON
