Skip to content

Commit

Permalink
docs: document installing with PyPI (#242)
Browse files Browse the repository at this point in the history
  • Loading branch information
woodruffw authored Dec 6, 2024
1 parent 0abccb4 commit b3c639f
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,31 @@ description: Installation instructions for zizmor.
brew install zizmor
```

=== "PyPI"

!!! tip

Despite being available on PyPI, `zizmor` is a compiled binary
and has no Python or Python package dependencies.


`zizmor` is available on [PyPI](https://pypi.org) and can be installed
with any Python package installer:

```bash
# with pip
pip install zizmor

# with pipx
pipx install zizmor

# with uv
uv tool install zizmor

# or, shortcut:
uvx zizmor --help
```

=== "Nix"

!!! note
Expand Down

0 comments on commit b3c639f

Please sign in to comment.