Skip to content

Commit

Permalink
Interactive mode: Mention IPython REPL requirement (#383)
Browse files Browse the repository at this point in the history
Mention that the ipython package is an optional requirement for using the IPython REPL, as described in the [source file](https://github.com/google/python-fire/blob/master/fire/interact.py#L17).
  • Loading branch information
gruberma committed Dec 9, 2022
1 parent e5b33f6 commit 1eec954
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/using-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@ will put you in an IPython REPL, with the variable `widget` already defined.
You can then explore the Python object that `widget` corresponds to
interactively using Python.

Note: if you want fire to start the IPython REPL instead of the regular Python one,
the `ipython` package needs to be installed in your environment.


### `--completion`: Generating a completion script <a name="completion-flag"></a>

Expand Down

0 comments on commit 1eec954

Please sign in to comment.