118 lines
3.5 KiB
Plaintext
118 lines
3.5 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: click-repl
|
|
Version: 0.3.0
|
|
Summary: REPL plugin for Click
|
|
Home-page: https://github.com/untitaker/click-repl
|
|
Author: Markus Unterwaditzer
|
|
Author-email: markus@unterwaditzer.net
|
|
License: MIT
|
|
Platform: UNKNOWN
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Requires-Python: >=3.6
|
|
Description-Content-Type: text/markdown
|
|
License-File: LICENSE
|
|
Requires-Dist: click (>=7.0)
|
|
Requires-Dist: prompt-toolkit (>=3.0.36)
|
|
Provides-Extra: testing
|
|
Requires-Dist: pytest-cov (>=4.0.0) ; extra == 'testing'
|
|
Requires-Dist: pytest (>=7.2.1) ; extra == 'testing'
|
|
Requires-Dist: tox (>=4.4.3) ; extra == 'testing'
|
|
|
|
click-repl
|
|
===
|
|
|
|
[](https://github.com/click-contrib/click-repl/actions/workflows/tests.yml)
|
|
[](https://github.com/click-contrib/click-repl/LICENSE)
|
|
|
|
[](https://pypi.org/project/click-repl/)
|
|
|
|
|
|
|
|
|
|
Installation
|
|
===
|
|
|
|
Installation is done via pip:
|
|
```
|
|
pip install click-repl
|
|
```
|
|
Usage
|
|
===
|
|
|
|
In your [click](http://click.pocoo.org/) app:
|
|
|
|
```py
|
|
import click
|
|
from click_repl import register_repl
|
|
|
|
@click.group()
|
|
def cli():
|
|
pass
|
|
|
|
@cli.command()
|
|
def hello():
|
|
click.echo("Hello world!")
|
|
|
|
register_repl(cli)
|
|
cli()
|
|
```
|
|
In the shell:
|
|
```
|
|
$ my_app repl
|
|
> hello
|
|
Hello world!
|
|
> ^C
|
|
$ echo hello | my_app repl
|
|
Hello world!
|
|
```
|
|
**Features not shown:**
|
|
|
|
- Tab-completion.
|
|
- The parent context is reused, which means `ctx.obj` persists between
|
|
subcommands. If you're keeping caches on that object (like I do), using the
|
|
app's repl instead of the shell is a huge performance win.
|
|
- `!` - prefix executes shell commands.
|
|
|
|
You can use the internal `:help` command to explain usage.
|
|
|
|
Advanced Usage
|
|
===
|
|
|
|
For more flexibility over how your REPL works you can use the `repl` function
|
|
directly instead of `register_repl`. For example, in your app:
|
|
|
|
```py
|
|
import click
|
|
from click_repl import repl
|
|
from prompt_toolkit.history import FileHistory
|
|
|
|
@click.group()
|
|
def cli():
|
|
pass
|
|
|
|
@cli.command()
|
|
def myrepl():
|
|
prompt_kwargs = {
|
|
'history': FileHistory('/etc/myrepl/myrepl-history'),
|
|
}
|
|
repl(click.get_current_context(), prompt_kwargs=prompt_kwargs)
|
|
|
|
cli()
|
|
```
|
|
And then your custom `myrepl` command will be available on your CLI, which
|
|
will start a REPL which has its history stored in
|
|
`/etc/myrepl/myrepl-history` and persist between sessions.
|
|
|
|
Any arguments that can be passed to the [`python-prompt-toolkit`](https://github.com/prompt-toolkit/python-prompt-toolkit) [Prompt](http://python-prompt-toolkit.readthedocs.io/en/stable/pages/reference.html?prompt_toolkit.shortcuts.Prompt#prompt_toolkit.shortcuts.Prompt) class
|
|
can be passed in the `prompt_kwargs` argument and will be used when
|
|
instantiating your `Prompt`.
|
|
|
|
|