jazzband/pip-tools

[advice] pip-{compile,sync} have completions, why not add some document about it to README.md?

Open

#1,702 opened on Oct 13, 2022

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Python (7,230 stars) (605 forks)batch import
docsgood first issue

Description

See https://click.palletsprojects.com/en/8.1.x/shell-completion/#enabling-completion.

_PIP_SYNC_COMPLETE=zsh_source pip-sync |sudo tee /usr/share/zsh/site-functions/_pip-sync
_PIP_COMPILE_COMPLETE=zsh_source pip-compile |sudo tee /usr/share/zsh/site-functions/_pip-compile

Contributor guide

Tech stack
python
Domain
documentationcli
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic shell completion knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Add shell completion commands to README.md. The issue provides the exact commands for zsh. Consider providing examples for other shells as well. The README should document how to enable completion for pip compile and pip sync.