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.