Shell completions made easy.
Project description
This is not being maintained.
Please check: https://github.com/pwwang/pyparam for shell completions.
completions
Shell completions for your program made easy.
Installation
pip install completions
# install lastest version using poetry
git clone https://github.com/pwwang/completions
cd completions
poetry install
Usage
Defining your completions
You may define your completions, basically commands and options, by following schema (showed in yaml
, but can be any format supported by python-simpleconf
:
example.yaml
program:
# your program, or path to your program
name: completions-example
desc: Shell completions for your program made easy.
# whether global options should be inherited by commands
inherit: true
# options or global options if you have commands
options:
-s: The shell, one of bash, fish, zsh and auto.
--shell: The shell, one of bash, fish, zsh and auto.
-a: Automatically write completions to destination file.
--auto: Automatically write completions to destination file.
commands:
# No other options for command, give the description
self: Generate completions for myself.
generate:
desc: Generate completions from configuration files.
options:
-c: The configuration file to load.
--config: The configuration file to load.
How it looks like in fish
:
Generating completion scripts
- Bash
> completions generate --shell bash \ --config example.yaml > ~/bash_completion.d/completions.bash-completion
You may need tosource
it in your.bashrc
and restart your shell for the changes to take effect. - Fish
> completions generate --shell fish \ --config example.yaml > ~/.config/fish/completions/completions.fish
You may need to restart your shell for the changes to take effect. - Zsh
> completions generate --shell zsh \ --config example.yaml > ~/.zsh-completions/_completions
Make surefpath+=~/.zsh-completions
is put beforecompinit
in you.zshrc
Saving completions scripts automatically
-
Bash
> completions generate --shell bash --config example.yaml --auto
-
Fish
> completions generate --shell fish --config example.yaml --auto
-
Zsh
> completions generate --shell zsh --config example.yaml --auto
Python API
from completions import Completions
completions = Completions(
# if not given, will be read from sys.argv[0]
name = 'completions',
# Add global options to commands
inherit = True,
desc = 'Shell completions for your program made easy.')
completions.addOption(
['-s', '--shell'],
'The shell, one of bash, fish, zsh and auto.')
completions.addOption(
['-a', '--auto'],
'Automatically write completions to destination file.')
completions.addCommand(
'self', 'Generate completions for myself.')
completions.addCommand(
'generate', 'Generate completions from configuration files.')
completions.command('generate').addOption(
['-c', '--config'], 'The configuration file to load.')
completions.generate(shell = 'fish', auto = False)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for completions-resurrection-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7eed332350aef3e3bdf7d6854bf880b12489689b9488757984e9689147aeff25 |
|
MD5 | a76b5ea9e3483c9a735c95c625baa396 |
|
BLAKE2b-256 | cf8d4a6007f3b06c07d537cb3257e67f3874e9879c87baf5909dd477df1efd13 |
Close
Hashes for completions_resurrection-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7d04475b145ac5d5c867e7feca0a4aedad45066607d5f0e482a24df91bdd680 |
|
MD5 | 437ccf33c8e6372911c5bd63763675b8 |
|
BLAKE2b-256 | e91257b2c820a043b9b8bc005a66ee2c70c1b7ff1db86eed214e65465791384e |