Python Fire

Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object.
Alternatives To Python Fire
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Python Fire24,276584849a day ago9January 22, 2021135otherPython
Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object.
Ts Node11,558143,62180,7613 days ago126July 14, 2022148mitTypeScript
TypeScript execution and REPL for node.js
Psysh9,50382,4235775 days ago86July 28, 202240mitPHP
A REPL for PHP
Fq5,866
a day ago96August 25, 202234otherGo
jq for binary formats - tool, language and decoders for working with binary and text formats
Alive Progress4,2571098 days ago26April 01, 202216mitPython
A new kind of Progress Bar, with real-time throughput, ETA, and very cool animations!
Evans3,604517 hours ago48August 26, 202221mitGo
Evans: more expressive universal gRPC client
Go Pry2,9484a month agoMay 24, 20216mitGo
An interactive REPL for Go that allows you to drop into your code at any point.
Mancy2,654
4 years ago55mitJavaScript
>_ Electron based NodeJS REPL :see_no_evil:
Discord Musicbot2,365
a day ago19otherJavaScript
An advanced discord music bot, supports Spotify, Soundcloud, YouTube with Shuffling, Volume Control and Web Dashboard with Slash Commands support!
Gitsh1,940
2 years ago37bsd-3-clauseRuby
An interactive shell for git
Alternatives To Python Fire
Select To Compare


Alternative Project Comparisons
Readme

Python Fire PyPI

Python Fire is a library for automatically generating 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

To install Python Fire with pip, run: pip install fire

To install Python Fire with conda, run: conda install fire -c conda-forge

To install Python Fire from source, first clone the repository and then run: python setup.py install

Basic Usage

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

Here's an example of calling Fire on a function.

import fire

def hello(name="World"):
  return "Hello %s!" % name

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

Then, from the command line, you can run:

python hello.py  # Hello World!
python hello.py --name=David  # Hello David!
python hello.py --help  # Shows usage information.

Here's an example of calling Fire on a class.

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

Setup Command Notes
install pip install fire
Creating a CLI Command Notes
import import fire
Call fire.Fire() Turns the current module into a Fire CLI.
Call fire.Fire(component) Turns component into a Fire CLI.
Using a CLI Command Notes
Help command --help or command -- --help
REPL command -- --interactive Enters interactive mode.
Separator command -- --separator=X Sets the separator to X. The default separator is -.
Completion command -- --completion [shell] Generates a completion script for the CLI.
Trace command -- --trace Gets a Fire trace for the command.
Verbose command -- --verbose

Note that these flags are separated from the Fire command by an isolated --.

License

Licensed under the Apache 2.0 License.

Disclaimer

This is not an official Google product.

Popular Command Line Projects
Popular Repl Projects
Popular Command Line Interface Categories

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
Python
Cli
Repl