jazzband/pip-tools

Document that pyproject.toml dependencies are supported

Open

#1 528 ouverte le 5 nov. 2021

Voir sur GitHub
 (3 commentaires) (7 réactions) (0 assignés)Python (7 230 stars) (605 forks)batch import
PR wanteddocsgood first issue

Description

What's the problem this feature will solve?

Issues like: #1510, general confusion

Describe the solution you'd like

At the moment, the docs include phrases like:

The pip-compile command lets you compile a requirements.txt file from your dependencies, specified in either setup.py or requirements.in.

pip-compile generates a requirements.txt file using the latest versions that fulfil the dependencies of setup.py or requirements.in.

To me, and I assume the person who opened #1510, this reads like only setup.py or requirements.in are supported.

Guide contributeur

Stack technique
python
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Python packaging basicspip tools familiaritypyproject.toml understanding
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
The issue requests updating documentation references to include pyproject.toml alongside setup.py and requirements.in. Start by searching the repository's documentation files (e.g., README.rst, docs/index.rst) for phrases like 'setup.py or requirements.in' and add pyproject.toml as a supported format. Verify in the source code (e.g., pipcompile.py) that pyproject.toml is indeed supported to ensure accuracy. Finally, ensure all occurrences across the docs are consistently updated.