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 (1,418 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (26,214 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Trace how fire resolves the module name in the CLI and modify it to use the package name when ` main .py` is invoked.
Tech stack
python
Domain
cli
Issue type
Bug
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 basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75