Setup docs still say `python setup.py install`, but `setup.py` was removed
Bewertung
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 93/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Aktualisiere die Installationsbefehle in README.md, docs/index.md, docs/guide.md und docs/installation.md und korrigiere anschließend die Anweisungen für Testabhängigkeiten in CONTRIBUTING.md mithilfe des in pyproject.toml definierten Test-Extras. Vergleiche zunächst diese Dateien mit pyproject.toml; fertig ist die Aufgabe, wenn die dokumentierten Installations- und Testbefehle mit der aktuellen Projekteinrichtung übereinstimmen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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).
- Vorherrschende Sprache
- Python
- Sterne
- 28.2k
- Forks
- 1.5k
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus google/python-fire
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
google/python-fire#733 ·
-
External pager resets custom SIGINT handlers to SIG_DFLEvtl. vergeben @hugosmoreira hat das vor 14 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
google/python-fire#723 · 1 Kommentar ·
-
EllipsisMiddleTruncate exceeds requested width when only the ellipsis fitsEvtl. vergeben @hugosmoreira hat das vor 14 Tagen übernommen. Offen
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 88/100
google/python-fire#722 · 1 Kommentar ·
-
Windows ANSI initialization uses nonexistent subprocess.STD_OUTPUT_HANDLEEvtl. vergeben @Fire162 hat das vor 11 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
google/python-fire#721 · 1 Kommentar ·
-
Calling an async command from an active event loop raises RuntimeError and leaves an unawaited coroutineEvtl. vergeben @aashish254 hat das vor 20 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
google/python-fire#716 ·
Alle Issues in google/python-fire
Ähnliche Issues
-
`destroy` sans terminal répond « Aborted. » au lieu de réclamer `--yes` comme `clean` et `reset`Offenbug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
stephrobert/dsoxlab#354 ·
Maintainer antworten meist innerhalb von 1 Tag
-
hardware help wanted testing
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
jasonacox/pypowerwall#472 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[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 failsEvtl. vergeben @vrjdev hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
DoubleML/doubleml-for-py#455 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[Bug]: Python mod.Box[T] annotation gets a false generic_arg edge that replaces the parameter_type one ('is' on tree-sitter nodes)Evtl. vergeben @rohit-jsfreaky hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
Graphify-Labs/graphify#5110 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 2 Tagen