Setup docs still say `python setup.py install`, but `setup.py` was removed
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 93/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- python
调研方向
更新 README.md、docs/index.md、docs/guide.md 和 docs/installation.md 中的安装命令，然后使用 pyproject.toml 中定义的 test extra 修正 CONTRIBUTING.md 中关于测试依赖项的说明。先对照 pyproject.toml 检查这些文件；当文档中的安装和测试命令与项目当前配置一致时，即为完成。
由索引模型根据 Issue 内容生成。
描述
Description
The instructions for installing Python Fire from source tell users to run python setup.py install (or python setup.py develop). setup.py was removed when the project moved to pyproject.toml, so following these instructions fails right away. CONTRIBUTING.md also says the test dependencies are "listed in setup.py" and names mock, which is no longer a dependency (the tests use unittest.mock from the standard library).
Files needing change
| File | Line | Current text |
|---|---|---|
README.md |
25 | python setup.py install |
docs/index.md |
25 | python setup.py install |
docs/guide.md |
19 | python setup.py install |
docs/installation.md |
8 | python setup.py install ... python setup.py develop |
CONTRIBUTING.md |
51 | "install the test dependencies listed in setup.py (e.g. pytest, mock, termcolor, and hypothesis)" |
Suggested fix
Replace the old commands with their pip equivalents, which I verified locally in a fresh virtual environment:
- Install from source:
pip install . - Install for development:
pip install -e . - Install with test dependencies:
pip install -e ".[test]"(thetestextra inpyproject.toml), then runpytest
Suggested wording for CONTRIBUTING.md line 51:
To do this, first install the test dependencies with
pip install -e ".[test]"(they are listed under[project.optional-dependencies]inpyproject.toml). Then run the tests by runningpytestin the root directory of the repository.
Following these instructions, pip install -e ".[test]" followed by python -m pytest installs and runs the full test suite (273 tests collected).
- 主要语言
- Python
- 星标
- 28.2k
- 派生
- 1.5k
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
google/python-fire 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
google/python-fire#733 ·
-
External pager resets custom SIGINT handlers to SIG_DFL可能已有人在做 @hugosmoreira 于 14 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
google/python-fire#723 · 1 条评论 ·
-
EllipsisMiddleTruncate exceeds requested width when only the ellipsis fits可能已有人在做 @hugosmoreira 于 14 天前认领。 未关闭
难度 1/5 1-3 小时 新手友好度 88/100
google/python-fire#722 · 1 条评论 ·
-
Windows ANSI initialization uses nonexistent subprocess.STD_OUTPUT_HANDLE可能已有人在做 @Fire162 于 11 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
google/python-fire#721 · 1 条评论 ·
-
Calling an async command from an active event loop raises RuntimeError and leaves an unawaited coroutine可能已有人在做 @aashish254 于 20 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
google/python-fire#716 ·
查看 google/python-fire 的全部 Issue
相似的 Issue
-
`destroy` sans terminal répond « Aborted. » au lieu de réclamer `--yes` comme `clean` et `reset`未关闭bug
难度 2/5 1-3 小时 新手友好度 85/100
stephrobert/dsoxlab#354 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 77/100
jasonacox/pypowerwall#472 ·
维护者通常 1 天内回复
-
[Bug]: DoubleMLRDDData accepts a score_col that is no data column (as in its docstring example); the running variable then becomes a covariate and RDFlex fails可能已有人在做 @vrjdev 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
DoubleML/doubleml-for-py#455 ·
维护者通常 1 天内回复
-
[Bug]: Python mod.Box[T] annotation gets a false generic_arg edge that replaces the parameter_type one ('is' on tree-sitter nodes)可能已有人在做 @rohit-jsfreaky 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 88/100
Graphify-Labs/graphify#5110 · 1 条评论 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
assafelovic/gpt-researcher#2277 ·
维护者通常 10 天内回复