Skip to content
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

docs: document installing with PyPI #242

Merged
merged 1 commit into from
Dec 6, 2024
+25 −0
Merged

docs: document installing with PyPI #242

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
25 changes: 25 additions & 0 deletions docs/installation.md
View file
Open in desktop
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
Loading