diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-05 05:48:57 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-05 05:48:57 +0000 |
| commit | 59c12e6482ef9494f04c02015033de16f3e25870 (patch) | |
| tree | 82eb179c57c3b2ade24b6a61b9a1d27dc7de69cc /python-nb-clean.spec | |
| parent | b6ebe117e67dbf374bb3158892fb2e012eb68899 (diff) | |
automatic import of python-nb-cleanopeneuler20.03
Diffstat (limited to 'python-nb-clean.spec')
| -rw-r--r-- | python-nb-clean.spec | 727 |
1 files changed, 727 insertions, 0 deletions
diff --git a/python-nb-clean.spec b/python-nb-clean.spec new file mode 100644 index 0000000..a365ad2 --- /dev/null +++ b/python-nb-clean.spec @@ -0,0 +1,727 @@ +%global _empty_manifest_terminate_build 0 +Name: python-nb-clean +Version: 2.4.0 +Release: 1 +Summary: Clean Jupyter notebooks for versioning +License: ISC +URL: https://github.com/srstevenson/nb-clean +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/af/82/d3ab2085ef8babf6cfcad3024aa71db214617dc6a3905b971f881896a89b/nb_clean-2.4.0.tar.gz +BuildArch: noarch + +Requires: python3-nbformat + +%description +<p align="center"><img src="images/nb-clean.png" width=300></p> + +[](https://github.com/srstevenson/nb-clean/blob/main/LICENCE) +[](https://github.com/srstevenson/nb-clean) +[](https://pypi.org/project/nb-clean/) +[](https://pypi.org/project/nb-clean/) +[](https://github.com/srstevenson/nb-clean/actions) +[](https://app.codecov.io/gh/srstevenson/nb-clean) + +`nb-clean` cleans Jupyter notebooks of cell execution counts, metadata, outputs, +and (optionally) empty cells, preparing them for committing to version control. +It provides both a Git filter and pre-commit hook to automatically clean +notebooks before they're staged, and can also be used with other version control +systems, as a command line tool, and as a Python library. It can determine if a +notebook is clean or not, which can be used as a check in your continuous +integration pipelines. + +:warning: _`nb-clean` 2.0.0 introduced a new command line interface to make +cleaning notebooks in place easier. If you upgrade from a previous release, +you'll need to migrate to the new interface as described under +[Migrating to `nb-clean` 2](#migrating-to-nb-clean-2)._ + +## Installation + +To install the latest release from [PyPI], use [pip]: + +```bash +python3 -m pip install nb-clean +``` + +`nb-clean` can also be installed with [Conda]: + +```bash +conda install -c conda-forge nb-clean +``` + +In Python projects using [Poetry] or [Pipenv] for dependency management, add +`nb-clean` as a development dependency with `poetry add --dev nb-clean` or +`pipenv install --dev nb-clean`. `nb-clean` requires Python 3.7 or later. + +## Usage + +### Checking + +You can check if a notebook is clean with: + +```bash +nb-clean check notebook.ipynb +``` + +or by passing the notebook contents on standard input: + +```bash +nb-clean check < notebook.ipynb +``` + +To also check for empty cells, add the `-e`/`--remove-empty-cells` flag. To +ignore cell metadata, add the `-m`/`--preserve-cell-metadata` flag, optionally +with a selection of metadata fields to ignore. To ignore cell outputs, add the +`-o`/`--preserve-cell-outputs` flag. + +`nb-clean` will exit with status code 0 if the notebook is clean, and status +code 1 if it is not. `nb-clean` will also print details of cell execution +counts, metadata, outputs, and empty cells it finds. + +### Cleaning (interactive) + +You can clean a Jupyter notebook with: + +```bash +nb-clean clean notebook.ipynb +``` + +This cleans the notebook in place. You can also pass the notebook content on +standard input, in which case the cleaned notebook is written to standard +output: + +```bash +nb-clean clean < original.ipynb > cleaned.ipynb +``` + +To also remove empty cells, add the `-e`/`--remove-empty-cells` flag. To +preserve cell metadata, add the `-m`/`--preserve-cell-metadata` flag, optionally +with a selection of metadata fields to preserve. To preserve cell outputs, add +the `-o`/`--preserve-cell-outputs` flag. + +### Cleaning (Git filter) + +To add a filter to an existing Git repository to automatically clean notebooks +when they're staged, run the following from the working tree: + +```bash +nb-clean add-filter +``` + +This will configure a filter to remove cell execution counts, metadata, and +outputs. To also remove empty cells, use: + +```bash +nb-clean add-filter --remove-empty-cells +``` + +To preserve cell metadata, such as that required by tools such as [papermill], +use: + +```bash +nb-clean add-filter --preserve-cell-metadata +``` + +To preserve only specific cell metadata, e.g., `tags` and `special`, use: + +```bash +nb-clean add-filter --preserve-cell-metadata tags special +``` + +To preserve cell outputs, use: + +```bash +nb-clean add-filter --preserve-cell-outputs +``` + +`nb-clean` will configure a filter in the Git repository in which it is run, and +won't mutate your global or system Git configuration. To remove the filter, run: + +```bash +nb-clean remove-filter +``` + +### Cleaning (pre-commit hook) + +`nb-clean` can also be used as a [pre-commit] hook. You may prefer this to the +Git filter if your project already uses the pre-commit framework. + +Note that the Git filter and pre-commit hook work differently, with different +effects on your working directory. The pre-commit hook operates on the notebook +on disk, cleaning the copy in your working directory. The Git filter cleans +notebooks as they are added to the index, leaving the copy in your working +directory dirty. This means cell outputs are still visible to you in your local +Jupyter instance when using the Git filter, but not when using the pre-commit +hook. + +After installing [pre-commit], add the `nb-clean` hook by adding the following +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" + hooks: + - id: nb-clean +``` + +You can pass additional arguments to `nb-clean` with an `args` array. The +following example shows how to preserve only two specific metadata fields. Note +that, in the example, the final item `--` in the arg list is mandatory. The +option `--preserve-cell-metadata` may take an arbitrary number of field +arguments, and the `--` argument is needed to separate them from notebook +filenames, which `pre-commit` will append to the list of arguments. + +```yaml +repos: + - repo: https://github.com/srstevenson/nb-clean + rev: "2.4.0" + hooks: + - id: nb-clean + args: + - --remove-empty-cells + - --preserve-cell-metadata + - tags + - slideshow + - -- +``` + +Run `pre-commit install` to ensure the hook is installed, and +`pre-commit autoupdate` to update the hook to the latest release of `nb-clean`. + +### Preserving all nbformat metadata + +To ignore or preserve specifically the metadata defined in the +[`nbformat` documentation](https://nbformat.readthedocs.io/en/latest/format_description.html#cell-metadata), +use the following options: +`--preserve-cell-metadata collapsed scrolled deletable editable format name tags jupyter execution`. + +### 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` | + +## Copyright + +Copyright © 2017-2022 [Scott Stevenson]. + +`nb-clean` is distributed under the terms of the [ISC licence]. + +[conda]: https://docs.conda.io/ +[isc licence]: https://opensource.org/licenses/ISC +[papermill]: https://papermill.readthedocs.io/ +[pip]: https://pip.pypa.io/ +[pipenv]: https://pipenv.readthedocs.io/ +[poetry]: https://python-poetry.org/ +[pre-commit]: https://pre-commit.com/ +[pypi]: https://pypi.org/project/nb-clean/ +[scott stevenson]: https://scott.stevenson.io + + +%package -n python3-nb-clean +Summary: Clean Jupyter notebooks for versioning +Provides: python-nb-clean +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-nb-clean +<p align="center"><img src="images/nb-clean.png" width=300></p> + +[](https://github.com/srstevenson/nb-clean/blob/main/LICENCE) +[](https://github.com/srstevenson/nb-clean) +[](https://pypi.org/project/nb-clean/) +[](https://pypi.org/project/nb-clean/) +[](https://github.com/srstevenson/nb-clean/actions) +[](https://app.codecov.io/gh/srstevenson/nb-clean) + +`nb-clean` cleans Jupyter notebooks of cell execution counts, metadata, outputs, +and (optionally) empty cells, preparing them for committing to version control. +It provides both a Git filter and pre-commit hook to automatically clean +notebooks before they're staged, and can also be used with other version control +systems, as a command line tool, and as a Python library. It can determine if a +notebook is clean or not, which can be used as a check in your continuous +integration pipelines. + +:warning: _`nb-clean` 2.0.0 introduced a new command line interface to make +cleaning notebooks in place easier. If you upgrade from a previous release, +you'll need to migrate to the new interface as described under +[Migrating to `nb-clean` 2](#migrating-to-nb-clean-2)._ + +## Installation + +To install the latest release from [PyPI], use [pip]: + +```bash +python3 -m pip install nb-clean +``` + +`nb-clean` can also be installed with [Conda]: + +```bash +conda install -c conda-forge nb-clean +``` + +In Python projects using [Poetry] or [Pipenv] for dependency management, add +`nb-clean` as a development dependency with `poetry add --dev nb-clean` or +`pipenv install --dev nb-clean`. `nb-clean` requires Python 3.7 or later. + +## Usage + +### Checking + +You can check if a notebook is clean with: + +```bash +nb-clean check notebook.ipynb +``` + +or by passing the notebook contents on standard input: + +```bash +nb-clean check < notebook.ipynb +``` + +To also check for empty cells, add the `-e`/`--remove-empty-cells` flag. To +ignore cell metadata, add the `-m`/`--preserve-cell-metadata` flag, optionally +with a selection of metadata fields to ignore. To ignore cell outputs, add the +`-o`/`--preserve-cell-outputs` flag. + +`nb-clean` will exit with status code 0 if the notebook is clean, and status +code 1 if it is not. `nb-clean` will also print details of cell execution +counts, metadata, outputs, and empty cells it finds. + +### Cleaning (interactive) + +You can clean a Jupyter notebook with: + +```bash +nb-clean clean notebook.ipynb +``` + +This cleans the notebook in place. You can also pass the notebook content on +standard input, in which case the cleaned notebook is written to standard +output: + +```bash +nb-clean clean < original.ipynb > cleaned.ipynb +``` + +To also remove empty cells, add the `-e`/`--remove-empty-cells` flag. To +preserve cell metadata, add the `-m`/`--preserve-cell-metadata` flag, optionally +with a selection of metadata fields to preserve. To preserve cell outputs, add +the `-o`/`--preserve-cell-outputs` flag. + +### Cleaning (Git filter) + +To add a filter to an existing Git repository to automatically clean notebooks +when they're staged, run the following from the working tree: + +```bash +nb-clean add-filter +``` + +This will configure a filter to remove cell execution counts, metadata, and +outputs. To also remove empty cells, use: + +```bash +nb-clean add-filter --remove-empty-cells +``` + +To preserve cell metadata, such as that required by tools such as [papermill], +use: + +```bash +nb-clean add-filter --preserve-cell-metadata +``` + +To preserve only specific cell metadata, e.g., `tags` and `special`, use: + +```bash +nb-clean add-filter --preserve-cell-metadata tags special +``` + +To preserve cell outputs, use: + +```bash +nb-clean add-filter --preserve-cell-outputs +``` + +`nb-clean` will configure a filter in the Git repository in which it is run, and +won't mutate your global or system Git configuration. To remove the filter, run: + +```bash +nb-clean remove-filter +``` + +### Cleaning (pre-commit hook) + +`nb-clean` can also be used as a [pre-commit] hook. You may prefer this to the +Git filter if your project already uses the pre-commit framework. + +Note that the Git filter and pre-commit hook work differently, with different +effects on your working directory. The pre-commit hook operates on the notebook +on disk, cleaning the copy in your working directory. The Git filter cleans +notebooks as they are added to the index, leaving the copy in your working +directory dirty. This means cell outputs are still visible to you in your local +Jupyter instance when using the Git filter, but not when using the pre-commit +hook. + +After installing [pre-commit], add the `nb-clean` hook by adding the following +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" + hooks: + - id: nb-clean +``` + +You can pass additional arguments to `nb-clean` with an `args` array. The +following example shows how to preserve only two specific metadata fields. Note +that, in the example, the final item `--` in the arg list is mandatory. The +option `--preserve-cell-metadata` may take an arbitrary number of field +arguments, and the `--` argument is needed to separate them from notebook +filenames, which `pre-commit` will append to the list of arguments. + +```yaml +repos: + - repo: https://github.com/srstevenson/nb-clean + rev: "2.4.0" + hooks: + - id: nb-clean + args: + - --remove-empty-cells + - --preserve-cell-metadata + - tags + - slideshow + - -- +``` + +Run `pre-commit install` to ensure the hook is installed, and +`pre-commit autoupdate` to update the hook to the latest release of `nb-clean`. + +### Preserving all nbformat metadata + +To ignore or preserve specifically the metadata defined in the +[`nbformat` documentation](https://nbformat.readthedocs.io/en/latest/format_description.html#cell-metadata), +use the following options: +`--preserve-cell-metadata collapsed scrolled deletable editable format name tags jupyter execution`. + +### 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` | + +## Copyright + +Copyright © 2017-2022 [Scott Stevenson]. + +`nb-clean` is distributed under the terms of the [ISC licence]. + +[conda]: https://docs.conda.io/ +[isc licence]: https://opensource.org/licenses/ISC +[papermill]: https://papermill.readthedocs.io/ +[pip]: https://pip.pypa.io/ +[pipenv]: https://pipenv.readthedocs.io/ +[poetry]: https://python-poetry.org/ +[pre-commit]: https://pre-commit.com/ +[pypi]: https://pypi.org/project/nb-clean/ +[scott stevenson]: https://scott.stevenson.io + + +%package help +Summary: Development documents and examples for nb-clean +Provides: python3-nb-clean-doc +%description help +<p align="center"><img src="images/nb-clean.png" width=300></p> + +[](https://github.com/srstevenson/nb-clean/blob/main/LICENCE) +[](https://github.com/srstevenson/nb-clean) +[](https://pypi.org/project/nb-clean/) +[](https://pypi.org/project/nb-clean/) +[](https://github.com/srstevenson/nb-clean/actions) +[](https://app.codecov.io/gh/srstevenson/nb-clean) + +`nb-clean` cleans Jupyter notebooks of cell execution counts, metadata, outputs, +and (optionally) empty cells, preparing them for committing to version control. +It provides both a Git filter and pre-commit hook to automatically clean +notebooks before they're staged, and can also be used with other version control +systems, as a command line tool, and as a Python library. It can determine if a +notebook is clean or not, which can be used as a check in your continuous +integration pipelines. + +:warning: _`nb-clean` 2.0.0 introduced a new command line interface to make +cleaning notebooks in place easier. If you upgrade from a previous release, +you'll need to migrate to the new interface as described under +[Migrating to `nb-clean` 2](#migrating-to-nb-clean-2)._ + +## Installation + +To install the latest release from [PyPI], use [pip]: + +```bash +python3 -m pip install nb-clean +``` + +`nb-clean` can also be installed with [Conda]: + +```bash +conda install -c conda-forge nb-clean +``` + +In Python projects using [Poetry] or [Pipenv] for dependency management, add +`nb-clean` as a development dependency with `poetry add --dev nb-clean` or +`pipenv install --dev nb-clean`. `nb-clean` requires Python 3.7 or later. + +## Usage + +### Checking + +You can check if a notebook is clean with: + +```bash +nb-clean check notebook.ipynb +``` + +or by passing the notebook contents on standard input: + +```bash +nb-clean check < notebook.ipynb +``` + +To also check for empty cells, add the `-e`/`--remove-empty-cells` flag. To +ignore cell metadata, add the `-m`/`--preserve-cell-metadata` flag, optionally +with a selection of metadata fields to ignore. To ignore cell outputs, add the +`-o`/`--preserve-cell-outputs` flag. + +`nb-clean` will exit with status code 0 if the notebook is clean, and status +code 1 if it is not. `nb-clean` will also print details of cell execution +counts, metadata, outputs, and empty cells it finds. + +### Cleaning (interactive) + +You can clean a Jupyter notebook with: + +```bash +nb-clean clean notebook.ipynb +``` + +This cleans the notebook in place. You can also pass the notebook content on +standard input, in which case the cleaned notebook is written to standard +output: + +```bash +nb-clean clean < original.ipynb > cleaned.ipynb +``` + +To also remove empty cells, add the `-e`/`--remove-empty-cells` flag. To +preserve cell metadata, add the `-m`/`--preserve-cell-metadata` flag, optionally +with a selection of metadata fields to preserve. To preserve cell outputs, add +the `-o`/`--preserve-cell-outputs` flag. + +### Cleaning (Git filter) + +To add a filter to an existing Git repository to automatically clean notebooks +when they're staged, run the following from the working tree: + +```bash +nb-clean add-filter +``` + +This will configure a filter to remove cell execution counts, metadata, and +outputs. To also remove empty cells, use: + +```bash +nb-clean add-filter --remove-empty-cells +``` + +To preserve cell metadata, such as that required by tools such as [papermill], +use: + +```bash +nb-clean add-filter --preserve-cell-metadata +``` + +To preserve only specific cell metadata, e.g., `tags` and `special`, use: + +```bash +nb-clean add-filter --preserve-cell-metadata tags special +``` + +To preserve cell outputs, use: + +```bash +nb-clean add-filter --preserve-cell-outputs +``` + +`nb-clean` will configure a filter in the Git repository in which it is run, and +won't mutate your global or system Git configuration. To remove the filter, run: + +```bash +nb-clean remove-filter +``` + +### Cleaning (pre-commit hook) + +`nb-clean` can also be used as a [pre-commit] hook. You may prefer this to the +Git filter if your project already uses the pre-commit framework. + +Note that the Git filter and pre-commit hook work differently, with different +effects on your working directory. The pre-commit hook operates on the notebook +on disk, cleaning the copy in your working directory. The Git filter cleans +notebooks as they are added to the index, leaving the copy in your working +directory dirty. This means cell outputs are still visible to you in your local +Jupyter instance when using the Git filter, but not when using the pre-commit +hook. + +After installing [pre-commit], add the `nb-clean` hook by adding the following +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" + hooks: + - id: nb-clean +``` + +You can pass additional arguments to `nb-clean` with an `args` array. The +following example shows how to preserve only two specific metadata fields. Note +that, in the example, the final item `--` in the arg list is mandatory. The +option `--preserve-cell-metadata` may take an arbitrary number of field +arguments, and the `--` argument is needed to separate them from notebook +filenames, which `pre-commit` will append to the list of arguments. + +```yaml +repos: + - repo: https://github.com/srstevenson/nb-clean + rev: "2.4.0" + hooks: + - id: nb-clean + args: + - --remove-empty-cells + - --preserve-cell-metadata + - tags + - slideshow + - -- +``` + +Run `pre-commit install` to ensure the hook is installed, and +`pre-commit autoupdate` to update the hook to the latest release of `nb-clean`. + +### Preserving all nbformat metadata + +To ignore or preserve specifically the metadata defined in the +[`nbformat` documentation](https://nbformat.readthedocs.io/en/latest/format_description.html#cell-metadata), +use the following options: +`--preserve-cell-metadata collapsed scrolled deletable editable format name tags jupyter execution`. + +### 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` | + +## Copyright + +Copyright © 2017-2022 [Scott Stevenson]. + +`nb-clean` is distributed under the terms of the [ISC licence]. + +[conda]: https://docs.conda.io/ +[isc licence]: https://opensource.org/licenses/ISC +[papermill]: https://papermill.readthedocs.io/ +[pip]: https://pip.pypa.io/ +[pipenv]: https://pipenv.readthedocs.io/ +[poetry]: https://python-poetry.org/ +[pre-commit]: https://pre-commit.com/ +[pypi]: https://pypi.org/project/nb-clean/ +[scott stevenson]: https://scott.stevenson.io + + +%prep +%autosetup -n nb-clean-2.4.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-nb-clean -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 2.4.0-1 +- Package Spec generated |