jazzband/pip-tools

Document that pyproject.toml dependencies are supported

Open

#1,528 创建于 2021年11月5日

在 GitHub 查看
 (3 评论) (7 反应) (0 负责人)Python (7,230 star) (605 fork)batch import
PR wanteddocsgood first issue

描述

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.

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python packaging basicspip tools familiaritypyproject.toml understanding
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.