seer-pas-sdk 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

seer_pas_sdk/core/sdk.py

@@ -114,11 +114,11 @@ class SeerSDK:
         tenants : dict[str, str]
             A dictionary containing the institution names and tenant ids for the authenticated user.
         """
-        tenants = self.get_user_tenant()
+        tenants = self.get_user_tenant(index=False)
         if reverse:
-            return {x["tenantId"]: x["institution"] for x in tenants.values()}
+            return {x["tenantId"]: x["institution"] for x in tenants}
         else:
-            return {x["institution"]: x["tenantId"] for x in tenants.values()}
+            return {x["institution"]: x["tenantId"] for x in tenants}
 
     def switch_tenant(self, identifier: str):
         """
@@ -251,7 +251,9 @@ class SeerSDK:
                 )
             return spaces.json()
 
-    def get_plates(self, plate_id: str = None, as_df: bool = False):
+    def get_plates(
+        self, plate_id: str = None, plate_name: str = None, as_df: bool = False
+    ):
         """
         Fetches a list of plates for the authenticated user. If no `plate_id` is provided, returns all plates for the authenticated user. If `plate_id` is provided, returns the plate with the given `plate_id`, provided it exists.
 
@@ -298,11 +300,18 @@ class SeerSDK:
         URL = f"{self._auth.url}api/v1/plates"
         res = []
 
+        if not plate_id and not plate_name:
+            params = {"all": "true"}
+        elif plate_name:
+            params = {"searchFields": "plate_name", "searchItem": plate_name}
+        else:
+            params = dict()
+
         with self._get_auth_session() as s:
 
             plates = s.get(
                 f"{URL}/{plate_id}" if plate_id else URL,
-                params={"all": "true"},
+                params=params,
             )
             if plates.status_code != 200:
                 raise ValueError(
@@ -318,7 +327,12 @@ class SeerSDK:
 
         return res if not as_df else dict_to_df(res)
 
-    def get_projects(self, project_id: str = None, as_df: bool = False):
+    def get_projects(
+        self,
+        project_id: str = None,
+        project_name: str = None,
+        as_df: bool = False,
+    ):
         """
         Fetches a list of projects for the authenticated user. If no `project_id` is provided, returns all projects for the authenticated user. If `project_id` is provided, returns the project with the given `project_id`, provided it exists.
 
@@ -369,10 +383,19 @@ class SeerSDK:
             else f"{self._auth.url}api/v1/projects/{project_id}"
         )
         res = []
+        if not project_id and not project_name:
+            params = {"all": "true"}
+        elif project_name:
+            params = {
+                "searchFields": "project_name",
+                "searchItem": project_name,
+            }
+        else:
+            params = dict()
 
         with self._get_auth_session() as s:
 
-            projects = s.get(URL, params={"all": "true"})
+            projects = s.get(URL, params=params)
             if projects.status_code != 200:
                 raise ValueError(
                     "Invalid request. Please check your parameters."
@@ -679,6 +702,7 @@ class SeerSDK:
         self,
         analysis_protocol_name: str = None,
         analysis_protocol_id: str = None,
+        as_df: bool = False,
     ):
         """
         Fetches a list of analysis protocols for the authenticated user. If no `analysis_protocol_id` is provided, returns all analysis protocols for the authenticated user. If `analysis_protocol_name` (and no `analysis_protocol_id`) is provided, returns the analysis protocol with the given name, provided it exists.
@@ -691,6 +715,8 @@ class SeerSDK:
         analysis_protocol_name : str, optional
             Name of the analysis protocol to be fetched, defaulted to None.
 
+        as_df : bool, optional
+            whether the result should be converted to a DataFrame, defaulted to False.
         Returns
         -------
         protocols: list[dict]
@@ -724,32 +750,41 @@ class SeerSDK:
             else f"{self._auth.url}api/v1/analysisProtocols/{analysis_protocol_id}"
         )
         res = []
+        params = {"all": "true"}
+
+        if analysis_protocol_name:
+            params.update(
+                {
+                    "searchFields": "analysis_protocol_name,offering_name",
+                    "searchItem": analysis_protocol_name,
+                }
+            )
 
         with self._get_auth_session() as s:
 
-            protocols = s.get(URL, params={"all": "true"})
+            protocols = s.get(URL, params=params)
             if protocols.status_code != 200:
                 raise ValueError(
                     "Invalid request. Please check your parameters."
                 )
-            if not analysis_protocol_id and not analysis_protocol_name:
-                res = protocols.json()["data"]
-
-            if analysis_protocol_id and not analysis_protocol_name:
+            if analysis_protocol_id:
                 res = [protocols.json()]
-
-            if not analysis_protocol_id and analysis_protocol_name:
-                res = [
-                    protocol
-                    for protocol in protocols.json()["data"]
-                    if protocol["analysis_protocol_name"]
-                    == analysis_protocol_name
-                ]
+            else:
+                res = protocols.json()["data"]
 
             for entry in range(len(res)):
                 if "tenant_id" in res[entry]:
                     del res[entry]["tenant_id"]
 
+                if "can_edit" in res[entry]:
+                    del res[entry]["can_edit"]
+
+                if "can_delete" in res[entry]:
+                    del res[entry]["can_delete"]
+
+                if "scope" in res[entry]:
+                    del res[entry]["scope"]
+
                 if "parameter_file_path" in res[entry]:
                     # Simple lambda function to find the third occurrence of '/' in the raw file path
                     location = lambda s: len(s) - len(s.split("/", 3)[-1])
@@ -758,7 +793,7 @@ class SeerSDK:
                         "parameter_file_path"
                     ][location(res[entry]["parameter_file_path"]) :]
 
-            return res
+            return res if not as_df else dict_to_df(res)
 
     def get_analyses(
         self,

{seer_pas_sdk-0.3.0.dist-info → seer_pas_sdk-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: seer-pas-sdk
-Version: 0.3.0
+Version: 0.3.1
 Summary: SDK for Seer Proteograph Analysis Suite (PAS)
 Author-email: Ryan Sun <rsun@seer.bio>
 License: 

{seer_pas_sdk-0.3.0.dist-info → seer_pas_sdk-0.3.1.dist-info}/RECORD

@@ -5,14 +5,14 @@ seer_pas_sdk/common/__init__.py,sha256=jA5qm-t9x3qXMp5Q6v7vV2kZdLw32-lnbtf0fPY4l
 seer_pas_sdk/common/errors.py,sha256=4HFORWnaQQCMXRE8kwdsJWvQRB_3KFEZ7yMb391e4gA,142
 seer_pas_sdk/common/groupanalysis.py,sha256=DxB-gbQfYzl7p9MTYWDIqghcH-IeakzdYdrRZrlIHek,1730
 seer_pas_sdk/core/__init__.py,sha256=rxbKgg-Qe24OaxX2zyHHYPYgDCTEKE_-41bB2wvpvL4,25
-seer_pas_sdk/core/sdk.py,sha256=Wt-cB1hB0dMZLDg0oZvO-NPGzKR70dCAdrZ4xKnC2zo,101286
+seer_pas_sdk/core/sdk.py,sha256=MXBFuatXU2rqjm99FZ23Hmnm0L_4d-4OORf7Avflbx4,102212
 seer_pas_sdk/core/unsupported.py,sha256=XAPZ3tidqjnsgftf3NUdTGIzvnsjHy0e_eGRCAo6GPo,59890
 seer_pas_sdk/objects/__init__.py,sha256=HJLS6sOr7DfzdI14fv5dWcITEj5QQsKcdfED3YNvUrY,107
 seer_pas_sdk/objects/groupanalysis.py,sha256=x3D_5NmYBoPDilNCQqUoCFARIfIeUq4FBY3_N6u8tfM,994
 seer_pas_sdk/objects/platemap.py,sha256=8IvJPAecs_e_FyqibzhCw-O4zjCFnf-zMUp_5krTEsg,5864
 seer_pas_sdk/objects/volcanoplot.py,sha256=tKuCWDIdoO8FLJlhpXhuwHn0aMYnvudTugxAslDXyGs,9357
-seer_pas_sdk-0.3.0.dist-info/licenses/LICENSE.txt,sha256=DVQuDIgE45qn836wDaWnYhSdxoLXgpRRKH4RuTjpRZQ,10174
-seer_pas_sdk-0.3.0.dist-info/METADATA,sha256=dpaBy3hI3vwikAThyVZeWjF5qNyiHrJhwEVSbmJA9rU,13448
-seer_pas_sdk-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-seer_pas_sdk-0.3.0.dist-info/top_level.txt,sha256=-2kZ-KFMGtXwr8H1O5llMKlcJ8gRKohEmrIvazXB61s,13
-seer_pas_sdk-0.3.0.dist-info/RECORD,,
+seer_pas_sdk-0.3.1.dist-info/licenses/LICENSE.txt,sha256=DVQuDIgE45qn836wDaWnYhSdxoLXgpRRKH4RuTjpRZQ,10174
+seer_pas_sdk-0.3.1.dist-info/METADATA,sha256=bW46nTpxACeDXYlqw3inU9EHDyQ-OlmnkJPxqaQKS-0,13448
+seer_pas_sdk-0.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+seer_pas_sdk-0.3.1.dist-info/top_level.txt,sha256=-2kZ-KFMGtXwr8H1O5llMKlcJ8gRKohEmrIvazXB61s,13
+seer_pas_sdk-0.3.1.dist-info/RECORD,,