google/python-fire

Use package name when __main__.py is used

Open

#76 geöffnet am 23. Mai 2017

Auf GitHub ansehen
 (1 Kommentar) (6 Reaktionen) (0 zugewiesene Personen)Python (26.214 Stars) (1.418 Forks)batch import
enhancementhelp wanted

Beschreibung

I'm investigating how to package a single file application with fire at the moment.

It seems that in order to have pip install the requirements, a setup.py files needs to exist. And setup.py requires that a package be defined. When this is done, a file, __main__.py is created in the package directory and invoked using, python -m mypackage COMMAND.

In this case the logic is in mypackage/__main__.py, which, when used with fire shows __main__.py in the usage output, where mypackage display is desirable.

Contributor Guide

Tech Stack
python
Domain
clitooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Python packaging basicspython fire usage
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
Examine the source code in the python fire repository to locate where the usage string (showing ' main .py') is generated. Likely in `fire/core.py` or `fire/trace.py`. Replace the hardcoded ' main .py' with the package name, which can be obtained via ` package ` or similar. Test the change by creating a simple package with ` main .py` and running `python m mypackage command` to verify the usage output now displays the package name.