Skip to content
This repository has been archived by the owner on Oct 12, 2023. It is now read-only.

Commit

Permalink
docs: recommend pipx for installation
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruvmanila committed Jun 13, 2023
1 parent dce59c0 commit f3a3cd1
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,27 @@ without removing it. How nice is that!
## Installation

You can install `remove-print-statements` from the Python Package Index (PyPI)
with `pip` or equivalent.
with [`pipx`] or equivalent.

```
python -m pip install remove-print-statements
pipx install remove-print-statements
```

Or with [pre-commit](https://pre-commit.com) in the `repos` section of your
Or, try it out using [`pipx`]:

```
pipx run remove-print-statements --help
```

Or, with [pre-commit](https://pre-commit.com) in the `repos` section of your
`.pre-commit-config.yaml` file ([docs](https://pre-commit.com/#plugins)):

```yaml
- repo: https://github.com/dhruvmanila/remove-print-statements
rev: '' # Replace with latest tag on GitHub
hooks:
- id: remove-print-statements
args: ['--verbose'] # Show all the print statements to be removed
# args: ['--verbose'] # Show all the print statements to be removed
```

## Usage
Expand Down Expand Up @@ -139,3 +145,4 @@ See [LICENSE](./LICENSE) for details.
<!-- References -->

[1]: https://adamj.eu/tech/2022/03/09/how-to-run-a-command-on-many-files-in-your-git-repository/
[`pipx`]: https://github.com/pypa/pipx

0 comments on commit f3a3cd1

Please sign in to comment.