CI-630 - Add tags to dataset create methods (#152)

* add example for tags and bump api client

* add example for import dataset

* add to sdk

* --help so exit code is 0

Author: nathanthorpe

.github/workflows/package.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Test install
         run: |
           poetry install --all-extras
-          poetry run cirro
+          poetry run cirro --help
 
       - name: Build python package
         run: |

cirro/sdk/project.py

@@ -2,7 +2,7 @@
 from time import sleep
 from typing import List, Union
 
-from cirro_api_client.v1.models import Project, UploadDatasetRequest, Dataset, Sample
+from cirro_api_client.v1.models import Project, UploadDatasetRequest, Dataset, Sample, Tag
 
 from cirro.cirro_client import CirroApi
 from cirro.file_utils import get_files_in_directory
@@ -145,7 +145,8 @@ def upload_dataset(
         description='',
         process: Union[DataPortalProcess, str] = None,
         upload_folder: str = None,
-        files: list = None
+        files: List[str] = None,
+        tags: List[str] = None,
     ):
         """
         Upload a set of files to the Data Portal, creating a new dataset.
@@ -158,6 +159,7 @@ def upload_dataset(
             process (str | DataPortalProcess): Process to run may be referenced by name, ID, or object
             upload_folder (str): Folder containing files to upload
             files (List[str]): Optional subset of files to upload from the folder
+            tags (List[str]): Optional list of tags to apply to the dataset
         """
 
         if name is None:
@@ -178,6 +180,10 @@ def upload_dataset(
         if files is None or len(files) == 0:
             raise RuntimeWarning("No files to upload, exiting")
 
+        # Normalize into Tag object
+        if tags is not None:
+            tags = [Tag(value=value) for value in tags]
+
         # Make sure that the files match the expected pattern
         self._client.processes.check_dataset_files(files, process.id, upload_folder)
 
@@ -186,7 +192,8 @@ def upload_dataset(
             process_id=process.id,
             name=name,
             description=description,
-            expected_files=files
+            expected_files=files,
+            tags=tags,
         )
 
         # Get the response

cirro/services/dataset.py

@@ -78,6 +78,20 @@ def import_public(self, project_id: str, import_request: ImportDataRequest) -> C
 
         Returns:
             ID of the created dataset
+
+        ```python
+        from cirro_api_client.v1.models import ImportDataRequest, Tag
+        from cirro.cirro_client import CirroApi
+
+        cirro = CirroApi()
+        request = ImportDataRequest(
+            name="Imported dataset",
+            description="Description of the dataset",
+            public_ids=["SRR123456", "SRR123457"],
+            tags=[Tag(value="tag1")]
+        )
+        cirro.datasets.import_public("project-id", request)
+        ```
         """
         return import_public_dataset.sync(project_id=project_id, client=self._api_client, body=import_request)
 
@@ -93,15 +107,16 @@ def create(self, project_id: str, upload_request: UploadDatasetRequest) -> Uploa
             ID of the created dataset and the path to upload files
 
         ```python
-        from cirro_api_client.v1.models import UploadDatasetRequest
+        from cirro_api_client.v1.models import UploadDatasetRequest, Tag
         from cirro.cirro_client import CirroApi
 
         cirro = CirroApi()
         request = UploadDatasetRequest(
             name="Name of new dataset",
             process_id="paired_dnaseq",
             expected_files=["read_1.fastq.gz", "read_2.fastq.gz"],
-            description="Description of the dataset"
+            description="Description of the dataset",
+            tags=[Tag(value="tag1"), Tag(value="tag2")]
         )
         cirro.datasets.create("project-id", request)
         ```