Refacto: replace click by argparse (#194)

Goal: reduce number of dependencies
qgis-deployment · Feb 28, 2023 · 91bb55d · 91bb55d
2 parents c4c3261 + c97fe3b
commit 91bb55d
Show file tree

Hide file tree

Showing 15 changed files with 455 additions and 319 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -79,6 +79,9 @@ jobs:
       - name: Install project as a package
         run: python -m pip install -e .
 
+      - name: QDT - Echoing help
+        run: qdt --version
+
       - name: QDT - Echoing version
         run: qdeploy-toolbelt --version
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -43,7 +43,7 @@
     "sphinx.ext.napoleon",
     # 3rd party
     "myst_parser",
-    "sphinx_click",
+    "sphinx_argparse_cli",
     "sphinx_copybutton",
     "sphinxext.opengraph",
 ]
@@ -133,12 +133,12 @@
 myst_enable_extensions = [
     "colon_fence",
     "deflist",
-    "dollarmath",
     "html_admonition",
     "html_image",
     # "linkify",
     "replacements",
     "smartquotes",
+    "strikethrough",
     "substitution",
 ]
 

diff --git a/docs/usage/cli.md b/docs/usage/cli.md
@@ -2,16 +2,10 @@
 
 ## Main command
 
-```{eval-rst}
-.. click:: qgis_deployment_toolbelt.cli:qgis_deployment_toolbelt
-   :prog: qdeploy-toolbelt
-```
-
----
-
-## Sub-commands
-
-```{eval-rst}
-.. click:: qgis_deployment_toolbelt.commands.cli_upgrade:upgrade
-   :prog: upgrade
+```{sphinx_argparse_cli}
+  :module: qgis_deployment_toolbelt.cli
+  :hook:
+  :func: main
+  :prog: qdeploy-toolbelt
+  :title: Commands and options
 ```
diff --git a/docs/usage/how_it_works.md b/docs/usage/how_it_works.md
@@ -1,4 +1,4 @@
-# How it works
+# How does it works
 
 > TO DOC
 

diff --git a/qgis_deployment_toolbelt/__about__.py b/qgis_deployment_toolbelt/__about__.py
@@ -21,7 +21,7 @@
 __author__ = "Julien Moura (Oslandia), Vincent Bré (Oslandia)"
 __copyright__ = "2021 - {0}, {1}".format(date.today().year, __author__)
 __email__ = "qgis@oslandia.com"
-__executable_name__ = "QGIS_DeploymentCLI.exe"
+__executable_name__ = "qgis-deployment-toolbelt"
 __package_name__ = "qgis-deployment-toolbelt"
 __keywords__ = ["cli, QGIS, deployment, profiles"]
 __license__ = "GNU Lesser General Public License v3.0"