pypa / pypa/packaging.python.org

Recommend dependency version management tooling based on use case

Open
#367 15 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted type: enhancement
Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

Similar to the problem in https://github.com/pypa/python-packaging-user-guide/issues/118 with regards to virtual environment management, our current tooling recommendations don't provide a pointer to higher level dependency version management tools like pipenv or pip-tools, they only refer to pip itself.

While we don't want to overwhelm people with choice, I think we're currently doing folks a disservice by letting them think pip is all there is, rather than guiding them towards more opinionated higher level tooling:

  • pipenv: web application development (and potentially other forms of application development)
  • pip-tools: general application development (useful when pipenv doesn't align with your needs)
  • conda: language-independent cross-platform package (useful when you have extensive external dependencies)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the current tooling recommendations and the related python-packaging-user-guide issue 118. Determine where pip is currently presented and update that documentation to guide readers toward pipenv, pip-tools, or conda based on their use case. Done means the recommendations are clear without overwhelming readers with unnecessary choices.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.