Merge pull request #1 from opengisch/no_ssl_verify

Added a global argument to skip SSL checks

Author: robert197

.github/workflows/deploy_to_pypi.yml

@@ -22,14 +22,14 @@ jobs:
       if: startsWith(github.ref, 'refs/tags/v')
       run: >-
         sed -i "s/= dev/= ${{ steps.v.outputs.VERSION }}/" setup.cfg
-        
+
     - name: Install pypa/build
       run: >-
         python -m
         pip install
         build
         --user
-        
+
     - name: Build a binary wheel and a source tarball
       run: >-
         python -m
@@ -38,7 +38,7 @@ jobs:
         --wheel
         --outdir dist/
         .
-        
+
     - name: 🚀 Upload Release Asset
       if: startsWith(github.ref, 'refs/tags/v')
       uses: actions/upload-release-asset@v1

README.md

@@ -52,15 +52,16 @@ qfieldcloud-cli --json list-projects
 ### Global options overview
 
 ```
--U, --url TEXT       URL to the QFieldCloud API endpoint. If not passed,
-                    gets the value from QFIELDCLOUD_URL environment
-                    variable. Default: https://app.qfield.cloud/api/v1/
-
--u, --username TEXT  Username or email.
+-U, --url TEXT                  URL to the QFieldCloud API endpoint. If not
+                                passed, gets the value from QFIELDCLOUD_URL
+                                environment variable. Default:
+                                https://app.qfield.cloud/api/v1/
+-u, --username TEXT             Username or email.
 -p, --password TEXT
--t, --token TEXT     Session token.
---json / --human     Output the result as newline formatted json.
---help               Show this message and exit.
+-t, --token TEXT                Session token.
+--json / --human                Output the result as newline formatted json. Default: False
+--verify-ssl / --no-verify-ssl  Verify SSL. Default: True
+--help                          Show this message and exit.
 ```
 
 Environment variables can be used instead of passing some common global options.
@@ -95,7 +96,7 @@ List QFieldCloud projects.
 qfieldcloud-cli list-projects [OPTIONS]
 
 Options:
-  --include-public / --no-public  Includes the public project in the list.
+  --include-public / --no-public  Includes the public project in the list. Default: False
 ```
 
 #### list-files
@@ -119,7 +120,7 @@ Options:
 
   --exit-on-error / --no-exit-on-error
                                   If any project file download fails stop
-                                  downloading the rest.
+                                  downloading the rest. Default: False
 ```
 
 ## Development

src/bin/qfieldcloud-cli

@@ -50,7 +50,15 @@ class OrderedGroup(click.Group):
     "-t", "--token", envvar="QFIELDCLOUD_TOKEN", type=str, help="Session token."
 )
 @click.option(
-    "--json/--human", "format_json", help="Output the result as newline formatted json."
+    "--json/--human",
+    "format_json",
+    help="Output the result as newline formatted json. Default: False",
+)
+@click.option(
+    "--verify-ssl/--no-verify-ssl",
+    "verify_ssl",
+    default=True,
+    help="Verify SSL. Default: True",
 )
 @click.pass_context
 def cli(
@@ -60,6 +68,7 @@ def cli(
     password: str,
     token: str,
     format_json: bool,
+    verify_ssl: bool,
 ):
     """The official QFieldCloud CLI tool.
 
@@ -70,7 +79,7 @@ def cli(
     qfieldcloud-cli -u user -p pass -U https://localhost/api/v1/ list-projects
     """
     ctx.ensure_object(dict)
-    ctx.obj["client"] = sdk.Client(url)
+    ctx.obj["client"] = sdk.Client(url, verify_ssl)
     ctx.obj["format_json"] = format_json
     ctx.obj["token"] = token
 
@@ -105,7 +114,7 @@ def login(ctx, username, password) -> None:
 @click.option(
     "--include-public/--no-public",
     default=False,
-    help="Includes the public project in the list.",
+    help="Includes the public project in the list. Default: False",
 )
 @click.pass_context
 def list_projects(ctx, username, include_public):
@@ -153,7 +162,7 @@ def list_files(ctx, project_id):
 )
 @click.option(
     "--exit-on-error/--no-exit-on-error",
-    help="If any project file download fails stop downloading the rest.",
+    help="If any project file download fails stop downloading the rest. Default: False",
 )
 @click.pass_context
 def download_files(ctx, project_id, local_dir, subdir, exit_on_error):

src/qfieldcloud_sdk/sdk.py

@@ -14,10 +14,11 @@ class DownloadStatus(Enum):
 
 
 class Client:
-    def __init__(self, url: Optional[str]) -> None:
+    def __init__(self, url: Optional[str], verify_ssl: bool = True) -> None:
         """Prepares a new client. If the `url` is not provided, uses `QFIELDCLOUD_URL` from the environment."""
         self.url = url or os.environ.get("QFIELDCLOUD_URL", "")
         self.token = None
+        self.verify_ssl = verify_ssl
 
         if not self.url:
             raise Exception(
@@ -157,6 +158,7 @@ def _request(
             headers=headers_copy,
             files=files,
             stream=stream,
+            verify=self.verify_ssl,
             # redirects from POST requests automagically turn into GET requests, so better forbid redirects
             allow_redirects=(method != "POST"),
         )