google/python-fire

Use package name when __main__.py is used

Open

#76 ouverte le 23 mai 2017

Voir sur GitHub
 (1 commentaire) (6 réactions) (0 assignés)Python (26 214 stars) (1 418 forks)batch import
enhancementhelp wanted

Description

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.

Guide contributeur

Stack technique
python
Domaine
clitooling
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Python packaging basicspython fire usage
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.