Skip to content

Commit

Permalink
v0.2.0 (#262)
Browse files Browse the repository at this point in the history
* v0.2.0

* changelog

* ✏️

* 📝
  • Loading branch information
MarcoGorelli committed Sep 26, 2020
1 parent 0f1e493 commit 3fcd963
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 25 deletions.
40 changes: 18 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,21 @@
Adapter to run any standard code-quality tool on a Jupyter notebook.
Documentation is hosted [here](https://nbqa.readthedocs.io/en/latest/).

## Installation
## 🎉 Installation

Install `nbqa` with [pip](https://pip.pypa.io):

```bash
pip install -U nbqa
```

## Examples
## 🚀 Examples

Reformat your notebook with
[black](https://black.readthedocs.io/en/stable/):

```bash
$ nbqa black my_notebook.ipynb --line-length=96 --nbqa-mutate
$ nbqa black my_notebook.ipynb --nbqa-mutate
reformatted my_notebook.ipynb
All done! ✨ 🍰 ✨
1 files reformatted.
Expand Down Expand Up @@ -77,31 +77,28 @@ Got:
***Test Failed*** 1 failures.
```

## Configuration
Check for style guide enforcement with [flake8](https://flake8.pycqa.org/en/latest/):

Here\'s an example `.nbqa.ini` file - see
[configuration](https://nbqa.readthedocs.io/en/latest/configuration.html)
for more on configuration:
```bash
$ nbqa flake8 my_notebook.ipynb
my_notebook.ipynb:cell_3:1:1: F401 'import pandas as pd' imported but unused
```

```ini
[isort]
config = setup.cfg
mutate = 1
addopts = --treat-comment-as-code '# %%%%'
## 🔧 Configuration

[flake8]
config = setup.cfg
```
You can configure `nbQA` either at the command line, or by using a `pyproject.toml` file - see
[configuration](https://nbqa.readthedocs.io/en/latest/configuration.html)
for details and examples.

## Usage as pre-commit hook
## 👷 Usage as pre-commit hook

If you want to use `nbqa` with [pre-commit](https://pre-commit.com/),
here\'s an example of what you could add to your
`.pre-commit-config.yaml` file:

```yaml
- repo: https://github.com/nbQA-dev/nbQA
rev: 0.1.32
rev: 0.2.0
hooks:
- id: nbqa
args: ["flake8"]
Expand All @@ -115,7 +112,7 @@ here\'s an example of what you could add to your
additional_dependencies: ["isort"]
```

## Supported third party packages
## Supported third party packages

In theory, `nbqa` can adapt any Python code-quality tool to a Jupyter Notebook.

Expand All @@ -127,15 +124,13 @@ In practice, here are the tools it\'s been tested with:
- [mypy](http://mypy-lang.org/)
- [doctest](https://docs.python.org/3/library/doctest.html)

## Contributing
## 👥Contributing

I will give write-access to anyone who contributes anything useful
(e.g. pull request / bug report) - see the
[contributing guide](https://nbqa.readthedocs.io/en/latest/contributing.html)
for details on how to do so.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
Expand All @@ -156,4 +151,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!
5 changes: 5 additions & 0 deletions docs/history.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
=========
Changelog
=========

0.2.0 (2020-09-26)
------------------

First somewhat stable release, with ``flake8``, ``black``, ``isort``, ``mypy``, and ``doctest`` supported, and configuration via ``pyproject.toml``.
2 changes: 1 addition & 1 deletion nbqa/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

__author__ = """Marco Gorelli"""
__email__ = "m.e.gorelli@gmail.com"
__version__ = "0.1.32"
__version__ = "0.2.0"
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.1.32
current_version = 0.2.0

[flake8]
ignore = E203,E503,W504
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@
test_suite="tests",
tests_require=test_requirements,
url="https://github.com/MarcoGorelli/nbQA",
version="0.1.32",
version="0.2.0",
zip_safe=False,
)

0 comments on commit 3fcd963

Please sign in to comment.