google/python-fire

Use package name when __main__.py is used

Open

#76 opened on May 23, 2017

View on GitHub
 (1 comment) (6 reactions) (0 assignees)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.

Contributor guide

Tech stack
python
Domain
clitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python packaging basicspython fire usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.