Skip to content

docs: Add uv tool install instructions #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hiAndrewQuinn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add uv tool install instructions #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ pip install -e .

After this, you will have a python script `opf` that can be run directly or via `python -m opf`. The script can be used in 3 separate ways, as described below.

Alternatively, if you have [uv](https://docs.astral.sh/uv/getting-started/installation/) installed, you can install it as a single command `opf` with `uv tool install`:

```bash
uv tool install git+https://github.com/openai/privacy-filter
```

2. Run one-shot redaction:

By default, `opf` looks for a model at the directory pointed to by the `OPF_CHECKPOINT` variable, or `~/.opf/privacy_filter`. If a model is not found in the `~/.opf/privacy_filter` location, it will be downloaded.
Expand Down