From bb9175ef2c696e461c8b75dc38404263c7f5edf2 Mon Sep 17 00:00:00 2001 From: iamdefinitelyahuman Date: Wed, 25 Dec 2019 18:27:00 +0200 Subject: [PATCH] changelog, readme, bumpversion --- CHANGELOG.md | 3 +++ README.md | 14 +++++++++----- brownie/_cli/__main__.py | 2 +- docs/conf.py | 2 +- setup.cfg | 2 +- setup.py | 2 +- 6 files changed, 16 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ea1a93f1..a7ba0d5ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,11 +6,14 @@ This changelog format is based on [Keep a Changelog](https://keepachangelog.com/ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased](https://github.com/iamdefinitelyahuman/brownie) + +## [1.3.1](https://github.com/iamdefinitelyahuman/brownie/tree/v1.3.1) - 2019-12-25 ### Added - better error message for division by zero ### Fixed - Correctly save minified source offsets in build artifacts +- Coverage evaluation: isolate `active_branches` between jumps ## [1.3.0](https://github.com/iamdefinitelyahuman/brownie/tree/v1.3.0) - 2019-12-20 ### Added diff --git a/README.md b/README.md index 6c9ed1fa7..e91c04ff3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Brownie -[![Pypi Status](https://img.shields.io/pypi/v/eth-brownie.svg)](https://pypi.org/project/eth-brownie/) [![Build Status](https://img.shields.io/travis/com/iamdefinitelyahuman/brownie.svg)](https://travis-ci.com/iamdefinitelyahuman/brownie) [![Docs Status](https://readthedocs.org/projects/eth-brownie/badge/?version=latest)](https://eth-brownie.readthedocs.io/en/latest/) [![Coverage Status](https://coveralls.io/repos/github/iamdefinitelyahuman/brownie/badge.svg?branch=master)](https://coveralls.io/github/iamdefinitelyahuman/brownie?branch=master) +[![Pypi Status](https://img.shields.io/pypi/v/eth-brownie.svg)](https://pypi.org/project/eth-brownie/) [![Build Status](https://travis-ci.com/iamdefinitelyahuman/brownie.svg?branch=master)](https://travis-ci.com/iamdefinitelyahuman/brownie) [![Docs Status](https://readthedocs.org/projects/eth-brownie/badge/?version=latest)](https://eth-brownie.readthedocs.io/en/latest/) [![Coverage Status](https://coveralls.io/repos/github/iamdefinitelyahuman/brownie/badge.svg?branch=master)](https://coveralls.io/github/iamdefinitelyahuman/brownie?branch=master) Brownie is a Python framework for deploying, testing and interacting with Ethereum smart contracts. @@ -17,13 +17,13 @@ As Brownie relies on [py-solc-x](https://github.com/iamdefinitelyahuman/py-solc- You can install the latest release via ``pip``: ```bash -$ pip install eth-brownie +pip install eth-brownie ``` Or clone the repository and use ``setuptools`` for the most up-to-date version: ```bash -$ python3 setup.py install +python3 setup.py install ``` ## Quick Usage @@ -31,7 +31,7 @@ $ python3 setup.py install To set up the default folder and file structure for Brownie use: ```bash -$ brownie init +brownie init ``` Next, type ``brownie --help`` for basic usage information. @@ -45,7 +45,7 @@ Brownie documentation is hosted at [Read the Docs](https://eth-brownie.readthedo To run the tests, first install the developer dependencies: ```bash -$ pip install -r requirements-dev.txt +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. @@ -63,16 +63,19 @@ 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' ``` @@ -98,6 +101,7 @@ 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. + ```bash git commit -m "commit message" --no-verify ``` diff --git a/brownie/_cli/__main__.py b/brownie/_cli/__main__.py index 023ffa1a7..8342f98a3 100644 --- a/brownie/_cli/__main__.py +++ b/brownie/_cli/__main__.py @@ -11,7 +11,7 @@ from brownie.exceptions import ProjectNotFound from brownie.utils import color, notify -__version__ = "1.3.0" +__version__ = "1.3.1" __doc__ = """Usage: brownie [...] [options ] diff --git a/docs/conf.py b/docs/conf.py index 834978904..c9874fb57 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,7 +37,7 @@ def setup(sphinx): # The short X.Y version version = "" # The full version, including alpha/beta/rc tags -release = "v1.3.0" +release = "v1.3.1" # -- General configuration --------------------------------------------------- diff --git a/setup.cfg b/setup.cfg index e230e3a05..dec350b94 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.3.0 +current_version = 1.3.1 [bumpversion:file:setup.py] diff --git a/setup.py b/setup.py index 44c0ade02..8bea96cd4 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ setup( name="eth-brownie", packages=find_packages(), - version="1.3.0", # don't change this manually, use bumpversion instead + version="1.3.1", # don't change this manually, use bumpversion instead license="MIT", description="A Python framework for Ethereum smart contract deployment, testing and interaction.", # noqa: E501 long_description=long_description,