Based on the "Command-line Application Development" category.
Alternatively, view Python Fire alternatives based on common mentions on social networks and blogs.
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of Python Fire or a related project?
Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object.
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
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](docs/using-cli.md).
For additional examples, see [The Python Fire Guide](docs/guide.md).
When you call Fire, it fires off (executes) your command.
Please see [The Python Fire Guide](docs/guide.md).
| 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](docs/using-cli.md#help-flag) | command --help or command -- --help |
|
| [REPL](docs/using-cli.md#interactive-flag) | command -- --interactive |
Enters interactive mode. |
| [Separator](docs/using-cli.md#separator-flag) | command -- --separator=X |
Sets the separator to X. The default separator is -. |
| [Completion](docs/using-cli.md#completion-flag) | command -- --completion [shell] |
Generates a completion script for the CLI. |
| [Trace](docs/using-cli.md#trace-flag) | command -- --trace |
Gets a Fire trace for the command. |
| [Verbose](docs/using-cli.md#verbose-flag) | command -- --verbose |
Note that these flags are separated from the Fire command by an isolated --.
Licensed under the Apache 2.0 License.
This is not an official Google product.
*Note that all licence references and agreements mentioned in the Python Fire README section above
are relevant to that project's source code only.
Do not miss the trending, packages, news and articles with our weekly report.