jazzband/pip-tools

Document that pyproject.toml dependencies are supported

Open

#1.528 aberto em 5 de nov. de 2021

Ver no GitHub
 (3 comments) (7 reactions) (0 assignees)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.

Guia do colaborador

Pilha de tecnologia
python
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Python packaging basicspip tools familiaritypyproject.toml understanding
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80
Direção de pesquisa
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.