Add instructions for uv - #105
Open
grisu48 wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
The CI failure appears unrelated to me. |
acerv
requested changes
Aug 13, 2026
|
|
||
| pip install --user kirk | ||
|
|
||
| uvx --with kirk[ssh,ltx] kirk |
Collaborator
There was a problem hiding this comment.
ssh and ltx are optional features, they should belong to the correct section
Contributor
Author
There was a problem hiding this comment.
I could not find a section where this would fit. The best solution I could come up with is to provide two uvx commands: The default one and one with the optional dependencies. This should make it clear for users how they can be used and also that they are optional.
Does that address this concern?
Add instructions on how to install kirk using the `uv` package manager for Python including using the optional requirements. This should allow users to quickly get running with kirk using uv without looking into the pyproject.toml file for dependency discovery.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add instructions on how to install kirk using the
uvpackage manager for Python including using the optional requirements. This should allow users to quickly get running with kirk using uv without looking into the pyproject.toml file for dependency discovery.