Document shell completion set up

Hi,

Would be nice if silkaj registered with bash to offer TAB-completion of its various command-line options and arguments.

This seems helpful: https://stackoverflow.com/questions/52282173/extending-bash-completion-with-python-click

changed milestone to %0.7.0

added CLI enhancement labels

assigned to @moul

changed title from lacks bash-completion to Bash and Zsh completion

mentioned in commit 9f973a62

Ok, it’s quite easy to do with click.

I created two scripts which should be sourced: one for BASH and one for ZSH.

The autocompletion wasn’t working with ZSH, I found this trick to make it work.

changed title from Bash and Zsh completion to Shell completion

mentioned in issue #137 (closed)

As I understand, Debian package is generating it automatically at packaging step.

Is it interesting to keep the auto generated files in Silkaj repository?

For users installing from pip/PyPI, a documentation would be much appreciable.

It could also be interesting for the packaging for other distributions.

From the PyPI installation point of view, the folder should be included, then a source can be explained in the documentation.

Commit to cherry-pick: 9f973a62

May be delayed to next milestone because of other priorities.

https://github.com/click-contrib/click-completion has many shell support: bash, zsh, fish and powershell:

• Install click-completion and psutil for:
  • pip: setup.py
  • Install for pipenv as production dependency
• Document installation process
• Document this step for packagers
• Create install command
  • Useless command on Distribution package? How can we get rid of it? By not creating this command. Import this command from other file thanks to Click.

changed milestone to %0.8.0

changed milestone to %0.9.0

changed milestone to %0.10.0

changed milestone to %Backlog

unassigned @moul

added Documentation Install labels

assigned to @moul

Click v8.0 § Redesign the shell completion system now includes shell completion. I missed this information.

• Add documentation to Silkaj installation doc.

changed milestone to %0.12.0

changed title from Shell completion to Document shell completion set up

mentioned in commit 28a54ca3

mentioned in commit 69932a4a

mentioned in commit 83979326

mentioned in merge request !271 (merged)

mentioned in commit 83c7de89

mentioned in commit 666ce016

closed with merge request !271 (merged)