Merge pull request #2 from opengisch/path_starts_with

Fix hidden username requirement and rename 'subdir' parameter to 'path-starts-with'

Author: suricactus

README.md

@@ -115,8 +115,8 @@ Download QFieldCloud project files.
 qfieldcloud-cli download-files [OPTIONS] PROJECT_ID LOCAL_DIR
 
 Options:
-  --subdir TEXT                   Do not download the whole project, but only
-                                  the subdirectory passed.
+  --path-starts-with TEXT         Do not download the whole project, but only
+                                  the files which path starts with the string.
 
   --exit-on-error / --no-exit-on-error
                                   If any project file download fails stop

src/bin/qfieldcloud-cli

@@ -117,10 +117,9 @@ def login(ctx, username, password) -> None:
     help="Includes the public project in the list. Default: False",
 )
 @click.pass_context
-def list_projects(ctx, username, include_public):
+def list_projects(ctx, include_public):
     """List QFieldCloud projects."""
     projects = ctx.obj["client"].list_projects(
-        username=username,
         include_public=include_public,
     )
 
@@ -157,18 +156,18 @@ def list_files(ctx, project_id):
 @click.argument("project_id")
 @click.argument("local_dir")
 @click.option(
-    "--subdir",
-    help="Do not download the whole project, but only the subdirectory passed.",
+    "--path-starts-with",
+    help="Do not download the whole project, but only the files which path starts with the string.",
 )
 @click.option(
     "--exit-on-error/--no-exit-on-error",
     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):
+def download_files(ctx, project_id, local_dir, path_starts_with, exit_on_error):
     """Download QFieldCloud project files."""
     files = ctx.obj["client"].download_files(
-        project_id, local_dir, subdir, exit_on_error
+        project_id, local_dir, path_starts_with, exit_on_error
     )
 
     if ctx.obj["format_json"]:

src/qfieldcloud_sdk/sdk.py

@@ -55,7 +55,6 @@ def list_projects(
             "GET",
             "projects",
             params={
-                "username": username or "",
                 "include-public": "1" if include_public else "0",
             },
         )
@@ -70,15 +69,15 @@ def download_files(
         self,
         project_id: str,
         local_dir: str,
-        subdir: str = None,
+        path_starts_with: str = None,
         continue_on_error: bool = False,
     ) -> List[Dict]:
-        """Download the specified project files into the destination dir
+        """Download the specified project files into the destination dir.
 
         Args:
             project_id: id of the project to be downloaded
             local_dir: destination directory where the files will be downloaded
-            subdir: if specified, download only files that are withing that subdirectory, otherwise download all
+            path_starts_with: if specified, download only files that are within that path starts with, otherwise download all
         """
 
         files = self.list_files(project_id)
@@ -88,13 +87,17 @@ def download_files(
             file["status"] = DownloadStatus.PENDING
             file["status_reason"] = ""
 
+        files_to_download = []
+
         for file in files:
             local_file = Path(f'{local_dir}/{file["name"]}')
             resp = None
 
-            if subdir and not file["name"].startswith(subdir):
+            if path_starts_with and not file["name"].startswith(path_starts_with):
                 continue
 
+            files_to_download.append(file)
+
             try:
                 resp = self._request(
                     "GET",
@@ -126,7 +129,7 @@ def download_files(
                         f.write(chunk)
             files_count += 1
 
-        return files
+        return files_to_download
 
     def _request(
         self,