Python Fire

0.7.1 · active · verified Sun Apr 05

Python Fire is a library for automatically generating command-line interfaces (CLIs) from any Python object. It enables developers to turn functions, classes, objects, and dictionaries into CLIs with minimal code, simplifying the creation of powerful command-line tools. The current version is 0.7.1, with a consistent release cadence focusing on compatibility, feature enhancements, and bug fixes.

Warnings

breaking Python Fire dropped support for Python 2 starting with version 0.7.0. If your project relies on Python 2, you must use an older version of the library.
Fix: Upgrade your project to Python 3, or pin `fire` to a version less than 0.7.0 (e.g., `pip install 'fire<0.7.0'`).
gotcha Arguments passed to a Fire-generated CLI that start with `--` (e.g., `--my-flag`) might not have been correctly interpreted as strings in very old versions of Fire. This could lead to unexpected parsing errors.
Fix: Ensure you are using `fire` version `0.1.3` or newer. This issue was resolved in that release.
gotcha While `fire.Fire()` is typically called directly within a script, you can also use `python -m fire <module_name>` or `python -m fire <path_to_file.py>` to generate a CLI for an existing module or file without modifying its source code. This is useful for exploring or interacting with third-party libraries.
Fix: For an executable script, include `if __name__ == '__main__': fire.Fire(your_object)`. To interact with an arbitrary module, use the command line form: `python -m fire os.path` to expose the `os.path` module as a CLI.

Install

pip install fire Install latest version

Imports

Fire
```
from fire import Fire
```
Fire is the primary entry point for generating CLIs.

Quickstart

Define a Python function or class, then pass it to `fire.Fire()` within your script. When executed, Fire automatically creates a CLI from the object. You can run this example as `python your_script.py --name David --enthusiasm 3` or `python your_script.py --help`.

import fire

def greet(name='World', enthusiasm=1):
  """Greets the given name with specified enthusiasm."""
  return f"Hello {name}{'!' * enthusiasm}"

if __name__ == '__main__':
  fire.Fire(greet)

view raw JSON →