Merge branch 'TER-496_shell_completion' into 'master'

TER-496: add shell completion to tfwrapper commands

Closes TER-496

See merge request claranet/cloud/projects/terraform/tools/tfwrapper!107

Author: pdecat

.pre-commit-config.yaml

@@ -1,21 +1,23 @@
 repos:
-        - repo: https://github.com/pre-commit/pre-commit-hooks
-          rev: v4.0.1
-          hooks:
-                  - id: trailing-whitespace
-                  - id: end-of-file-fixer
-                  - id: check-added-large-files
-                  - id: check-toml
-                  - id: check-yaml
-        - repo: https://gitlab.com/pycqa/flake8
-          rev: 3.9.2
-          hooks:
-                  - id: flake8
-        - repo: https://github.com/psf/black
-          rev: 21.9b0
-          hooks:
-                  - id: black
-        - repo: https://codeberg.org/frnmst/md-toc
-          rev: 8.0.1
-          hooks:
-                  - id: md-toc
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-toml
+      - id: check-yaml
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-docstrings==1.6.0
+  - repo: https://github.com/psf/black
+    rev: 22.1.0
+    hooks:
+      - id: black
+  - repo: https://codeberg.org/frnmst/md-toc
+    rev: 8.1.1
+    hooks:
+      - id: md-toc

README.md

@@ -16,6 +16,7 @@
   - [Runtime Dependencies](#runtime-dependencies)
   - [Recommended setup](#recommended-setup)
   - [Installation](#installation)
+  - [Setup command-line completion](#setup-command-line-completion)
   - [Upgrade from tfwrapper v7 or older](#upgrade-from-tfwrapper-v7-or-older)
     - [Required files](#required-files)
   - [Configuration](#configuration)
@@ -38,6 +39,7 @@
     - [Stack path](#stack-path)
 - [Development](#development)
   - [Tests](#tests)
+  - [Debug command-line completion](#debug-command-line-completion)
   - [Python code formatting](#python-code-formatting)
   - [Checks](#checks)
   - [README TOC](#readme-toc)
@@ -57,6 +59,7 @@
 - Azure credentials loading (both Service Principal or User)
 - GCP and GKE user ADC support
 - Plugins caching
+- Tab completion
 
 ## Drawbacks
 
@@ -103,6 +106,18 @@ With zsh, you need to escape brackets:
 pipx install 'claranet-tfwrapper[azure]'
 ```
 
+## Setup command-line completion
+
+Add the following to your shell's interactive configuration file, e.g. `.bashrc` for bash:
+
+```bash
+eval "$(register-python-argcomplete tfwrapper -e tfwrapper)"
+```
+
+You can then press the completion key (usually `Tab ↹`) twice to get your partially typed `tfwrapper` commands completed.
+
+Note: the `-e tfwrapper` parameter adds an suffix to the defined `_python_argcomplete` function to avoid clashes with other packages (see https://github.com/kislyuk/argcomplete/issues/310#issuecomment-697168326 for context).
+
 ## Upgrade from tfwrapper v7 or older
 
 If you used versions of the wrapper older than v8, there is not much to do when upgrading to v8
@@ -623,6 +638,14 @@ All new code contributions should come with unit and/or integrations tests.
 
 To run those tests locally, use [tox](https://github.com/tox-dev/tox).
 
+## Debug command-line completion
+
+You can get verbose debugging information for `argcomplete` by defining the following environment variable:
+
+```bash
+export _ARC_DEBUG=1
+```
+
 ## Python code formatting
 
 Our code is formatted with [black](https://github.com/psf/black/).

poetry.lock

@@ -43,6 +43,7 @@ azure-cli-core = {version = "^2.30.0", optional = true}
 azure-common = {version = "^1.1.27", optional = true}
 azure-mgmt-storage = {version = "^18.0.0", optional = true}
 msrestazure = {version = "^0.6.4", optional = true}
+argcomplete = "<2.0"
 
 [tool.poetry.extras]
 azure = [