Setup docs still say `python setup.py install`, but `setup.py` was removed

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#718 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

@GreedyC đang làm issue này rồi.

Từ ngày 22/10/2026.

  • #719 của @GreedyC — đang mở

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
93/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Cập nhật các lệnh cài đặt trong README.md, docs/index.md, docs/guide.md và docs/installation.md, sau đó sửa hướng dẫn về các dependency kiểm thử trong CONTRIBUTING.md bằng test extra được định nghĩa trong pyproject.toml. Hãy bắt đầu bằng cách đối chiếu các tệp đó với pyproject.toml; hoàn tất khi các lệnh cài đặt và kiểm thử được ghi trong tài liệu khớp với cấu hình hiện tại của dự án.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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]" (the test extra in pyproject.toml), then run pytest

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] in pyproject.toml). Then run the tests by running pytest in 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).

Ngôn ngữ chính
Python
Star
28.2k
Fork
1.5k
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của google/python-fire

Tất cả issue của google/python-fire

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.