Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Commit

Permalink
Add instructions for PyPi installation
Browse files Browse the repository at this point in the history
  • Loading branch information
timvink committed Jan 13, 2022
1 parent 072b3ad commit 307d924
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ Jupyter notebooks contain not only code but also outputs (tables, plots, interac
## Installation

```bash
python -m pip install git+https://github.developer.allianz.io/allianz-direct/precommit_nbconvert_rename.git
pip install precommit_nbconvert_rename
```

> Why `python -m pip` instead of just `pip`? See this post on [why it has fewer problems](https://adamj.eu/tech/2020/02/25/use-python-m-pip-everywhere/)
## Usage

You need to update the `.pre-commit-config.yaml` in your repository. We'll assume you want to use `nbconvert_rename` with [nbstripout](https://github.com/kynan/nbstripout#using-nbstripout-as-a-pre-commit-hook) and include that here:
Expand Down

0 comments on commit 307d924

Please sign in to comment.