google/python-fire

 google / python-fire

google / python-fire

Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object.

python-fire61906190620062006210621062206220623062306240624062506250626062606270627062806280629062906300630063106310632063202017-05-132017-05-142017-05-152017-05-162017-05-172017-05-182017-05-192017-05-202017-05-212017-05-222017-05-232017-05-242017-05-252017-05-26python-fire61858.34650851448199.565737722017-05-13619140.4484643394191.2987229012017-05-14619472.5504201643187.1652154922017-05-156205104.652375989172.0090216582017-05-166211136.754331814163.7420068392017-05-176221168.856287639149.9636488082017-05-186231200.958243464136.1852907782017-05-196234233.060199289132.0517833682017-05-206243265.162155114119.651261142017-05-216281297.26411093967.2935006232017-05-226299329.36606676442.49245616732017-05-236305361.46802258934.22544134882017-05-246319393.56997841314.93574010552017-05-256327425.6719342383.913053680782017-05-26star

 README

Python Fire

Python Fire is a library for creating command line interfaces (CLIs) from absolutely any Python object.

  • Python Fire is a simple way to create a CLI in Python. [1]
  • Python Fire is a helpful tool for developing and debugging Python code. [2]
  • Python Fire helps with exploring existing code or turning other people's code into a CLI. [3]
  • Python Fire makes transitioning between Bash and Python easier. [4]
  • Python Fire makes using a Python REPL easier by setting up the REPL with the modules and variables you'll need already imported and created. [5]

Installation

pip install fire

Basic Usage

You can call Fire on any Python object:
functions, classes, modules, objects, dictionaries, lists, tuples, etc. They all work!

Here's a simple example.

import fire

class Calculator(object):
  """A simple calculator class."""

  def double(self, number):
    return 2 * number

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

Then, from the command line, you can run:

python calculator.py double 10  # 20
python calculator.py double --number=15  # 30

To learn how Fire behaves on functions, objects, dicts, lists, etc, and to learn about Fire's other features, see the Using a Fire CLI page.

For additional examples, see The Python Fire Guide.

Why is it called Fire?

When you call Fire, it fires off (executes) your command.

Where can I learn more?

Please see The Python Fire Guide.

Reference

SetupCommandNotes
installpip install fire
Creating a CLICommandNotes
importimport fire
Callfire.Fire()Turns the current module into a Fire CLI.
Callfire.Fire(component)Turns component into a Fire CLI.
Using a CLICommandNotes
Helpcommand -- --help
REPLcommand -- --interactiveEnters interactive mode.
Separatorcommand -- --separator=XThis sets the separator to X. The default separator is -.
Completioncommand -- --completionGenerate a completion script for the CLI.
Tracecommand -- --traceGets a Fire trace for the command.
Verbosecommand -- --verbose
Note that flags are separated from the Fire command by an isolated -- arg.

Disclaimer

This is not an official Google product.