Skip to content

Commit

Permalink
Bump version to 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@srstevenson
srstevenson committed Aug 27, 2023
1 parent c5f513e commit dd735cd
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 22 deletions.
2 changes: 1 addition & 1 deletion LICENCE
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright © 2017-2022 Scott Stevenson <scott@stevenson.io>
Copyright © Scott Stevenson <scott@stevenson.io>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
Expand Down
34 changes: 15 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ snippet to `.pre-commit-config.yaml` in the root of your repository:
```yaml
repos:
- repo: https://github.com/srstevenson/nb-clean
rev: 2.4.0
rev: 3.0.0
hooks:
- id: nb-clean
```
Expand All @@ -160,7 +160,7 @@ filenames, which `pre-commit` will append to the list of arguments.
```yaml
repos:
- repo: https://github.com/srstevenson/nb-clean
rev: 2.4.0
rev: 3.0.0
hooks:
- id: nb-clean
args:
Expand All @@ -184,26 +184,22 @@ use the following options:
### Migrating to `nb-clean` 2

The following table maps from the command line interface of `nb-clean` 1.6.0 to
that of `nb-clean` 2.4.0.

| Description | `nb-clean` 1.6.0 | `nb-clean` 2.4.0 |
| ------------------------------------------------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| Clean notebook | `nb-clean clean -i/--input notebook.ipynb \| sponge notebook.ipynb` | `nb-clean clean notebook.ipynb` |
| Clean notebook (remove empty cells) | `nb-clean clean -i/--input notebook.ipynb -e/--remove-empty` | `nb-clean clean notebook.ipynb -e/--remove-empty-cells` |
| Clean notebook (preserve cell metadata) | `nb-clean clean -i/--input notebook.ipynb -m/--preserve-metadata` | `nb-clean clean notebook.ipynb -m/--preserve-cell-metadata` |
| Clean notebook (preserve `tags` and `special` cell metadata) | | `nb-clean clean notebook.ipynb -m/--preserve-cell-metadata tags special` |
| Clean notebook (preserve cell outputs) | | `nb-clean clean notebook.ipynb -o/--preserve-cell-outputs` |
| Check notebook | `nb-clean check -i/--input notebook.ipynb` | `nb-clean check notebook.ipynb` |
| Check notebook (ignore non-empty cells) | `nb-clean check -i/--input notebook.ipynb -e/--remove-empty` | `nb-clean check notebook.ipynb -e/--remove-empty-cells` |
| Check notebook (ignore cell metadata) | `nb-clean check -i/--input notebook.ipynb -m/--preserve-metadata` | `nb-clean check notebook.ipynb -m/--preserve-cell-metadata` |
| Check notebook (ignore `tags` and `special` cell metadata) | | `nb-clean check notebook.ipynb -m/--preserve-cell-metadata tags special` |
| Check notebook (ignore cell outputs) | | `nb-clean check notebook.ipynb -o/--preserve-cell-outputs` |
| Add Git filter to clean notebooks | `nb-clean configure-git` | `nb-clean add-filter` |
| Remove Git filter | `nb-clean unconfigure-git` | `nb-clean remove-filter` |
that of `nb-clean` >=2.0.0.

| Description | `nb-clean` 1.6.0 | `nb-clean` >=2.0.0 |
| --------------------------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------- |
| Clean notebook | `nb-clean clean -i/--input notebook.ipynb \| sponge notebook.ipynb` | `nb-clean clean notebook.ipynb` |
| Clean notebook (remove empty cells) | `nb-clean clean -i/--input notebook.ipynb -e/--remove-empty` | `nb-clean clean notebook.ipynb -e/--remove-empty-cells` |
| Clean notebook (preserve cell metadata) | `nb-clean clean -i/--input notebook.ipynb -m/--preserve-metadata` | `nb-clean clean notebook.ipynb -m/--preserve-cell-metadata` |
| Check notebook | `nb-clean check -i/--input notebook.ipynb` | `nb-clean check notebook.ipynb` |
| Check notebook (ignore non-empty cells) | `nb-clean check -i/--input notebook.ipynb -e/--remove-empty` | `nb-clean check notebook.ipynb -e/--remove-empty-cells` |
| Check notebook (ignore cell metadata) | `nb-clean check -i/--input notebook.ipynb -m/--preserve-metadata` | `nb-clean check notebook.ipynb -m/--preserve-cell-metadata` |
| Add Git filter to clean notebooks | `nb-clean configure-git` | `nb-clean add-filter` |
| Remove Git filter | `nb-clean unconfigure-git` | `nb-clean remove-filter` |

## Copyright

Copyright © 2017-2022 [Scott Stevenson].
Copyright © [Scott Stevenson].

`nb-clean` is distributed under the terms of the [ISC licence].

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "nb-clean"
version = "2.4.0"
version = "3.0.0"
description = "Clean Jupyter notebooks for versioning"
authors = ["Scott Stevenson <scott@stevenson.io>"]
license = "ISC"
Expand Down
2 changes: 1 addition & 1 deletion src/nb_clean/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import nbformat
from typing_extensions import Self

VERSION = "2.4.0"
VERSION = "3.0.0"
GIT_ATTRIBUTES_LINE = "*.ipynb filter=nb-clean"


Expand Down

0 comments on commit dd735cd

Please sign in to comment.