jazzband/pip-tools

Improve Readme to explain how pip-compile is better than pip freeze

Open

#1,524 opened on Nov 4, 2021

View on GitHubContributor guide
 (3 comments) (5 reactions) (0 assignees)Python (670 forks)batch import
docsenhancementhelp wantedneeds discussionneeds more info

Repository metrics

Stars
 (8,009 stars)
PR merge metrics
 (Avg merge 1d 21h) (3 merged PRs in 30d)

Description

It would be interesting to explain the README the benefit of pip-compile vs. doing a pip install in a fresh environment followed by a pip freeze to dump out the pinned dependency versions.

Is it faster? In what usage patterns does it save time?

Contributor guide

Research direction
Explain the advantages of pip compile over pip freeze, focusing on speed and use cases.
Tech stack
python
Domain
documentation
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
Python packaging basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80