python / python/mypy

[maintenance] Upgrade the use of `pip-tools` to leverage its modern features

Open
#17,718 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Feature

$sbj. pip-tools now supports config files (through .pip-tools.toml or pyproject.tomlhttps://pip-tools.readthedocs.io/en/stable/#configuration). It also supports extracting the build requirements (https://pip-tools.readthedocs.io/en/stable/#maximizing-reproducibility).

Pitch

I saw a couple of pip-tools-managed files in the repo but no documentation on invoking pip-compile or a wrapper script for updating the pins. Having a config file would help with keeping the settings consistent if somebody calls it w/o all the expected args. Here's a config example I tend to use: https://github.com/cherrypy/cheroot/blob/1ff20b1/.pip-tools.toml.

As for the build deps, using one of --build-deps-for [editable|sdist|wheel], --all-build-deps or --only-build-deps can help you get rid of https://github.com/python/mypy/blob/fe15ee6/build-requirements.txt#L1 and https://github.com/python/mypy/blob/fe15ee6/mypy-requirements.txt#L1-L2 which relies on people having to remember to keep things in sync across to copies of deps lists.

cc @hauntsaninja since you were the last to touch build-requirements.txt and @AlexWaygood as you wrote the following in your commit message last changing mypy-requirements.txt:

(Can't say I fully understand why we have to have
this pin in three places :)

Contributor guide

Open the contributing guide

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 pip-tools configuration and build-requirements.txt and mypy-requirements.txt files mentioned in the issue, then compare them with pip-tools' configuration and build-dependency documentation. Identify how dependency pins are currently maintained and how invocation is documented. Done means consistent pip-tools settings, reduced duplicated dependency lists, and documented update commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.