labkey 3.1.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

labkey/__init__.py

@@ -14,6 +14,6 @@
 # limitations under the License.
 #
 __title__ = "labkey"
-__version__ = "3.1.0"
+__version__ = "3.2.0"
 __author__ = "LabKey"
 __license__ = "Apache License 2.0"

labkey/experiment.py

@@ -218,6 +218,70 @@ def save_batches(
     return None
 
 
+def lineage(
+    server_context: ServerContext,
+    lsids: List[str],
+    children: bool = None,
+    container_path: str = None,
+    cpas_type: str = None,
+    depth: int = None,
+    exp_type: str = None,
+    include_inputs_and_outputs: bool = None,
+    include_properties: bool = None,
+    include_run_steps: bool = None,
+    parents: bool = None,
+    run_protocol_lsid: str = None,
+):
+    """
+    :param server_context: A LabKey server context. See utils.create_server_context.
+    :param lsids: Array of LSIDs for the seed ExpData, ExpMaterials, or ExpRun
+    :param children: Include children in the lineage response. Defaults to true.
+    :param container_path: labkey container path if not already set in context
+    :param cpas_type: Optional LSID of a SampleSet or DataClass to filter the response. Defaults to include all.
+    :param depth: An optional depth argument. Defaults to include all.
+    :param exp_type: Optional experiment type to filter response -- either "Data", "Material", or "ExperimentRun".
+    Defaults to include all.
+    :param include_inputs_and_outputs: Include inputs and outputs in the lineage response.
+    :param include_properties: Include properties in the lineage response.
+    :param include_run_steps: Include run steps in the lineage response.
+    :param parents: Include parents in the lineage response. Defaults to true.
+    :param run_protocol_lsid: Optional Exp Run Protocol Lsid to filter response. Defaults to include all.
+    """
+    lineage_url = server_context.build_url(
+        "experiment", "lineage.api", container_path=container_path
+    )
+    payload = {"lsids": lsids}
+
+    if children is not None:
+        payload["children"] = children
+
+    if cpas_type is not None:
+        payload["cpasType"] = cpas_type
+
+    if depth is not None:
+        payload["depth"] = depth
+
+    if exp_type is not None:
+        payload["expType"] = exp_type
+
+    if include_inputs_and_outputs is not None:
+        payload["includeInputsAndOutputs"] = include_inputs_and_outputs
+
+    if include_properties is not None:
+        payload["includeProperties"] = include_properties
+
+    if include_run_steps is not None:
+        payload["includeRunSteps"] = include_run_steps
+
+    if parents is not None:
+        payload["parents"] = parents
+
+    if run_protocol_lsid is not None:
+        payload["runProtocolLsid"] = run_protocol_lsid
+
+    return server_context.make_request(lineage_url, payload=payload, method="POST")
+
+
 class ExperimentWrapper:
     """
     Wrapper for all of the API methods exposed in the experiment module. Used by the APIWrapper class.
@@ -237,3 +301,33 @@ class ExperimentWrapper:
     @functools.wraps(save_batches)
     def save_batches(self, assay_id: int, batches: List[Batch]) -> Optional[List[Batch]]:
         return save_batches(self.server_context, assay_id, batches)
+
+    @functools.wraps(lineage)
+    def lineage(
+        self,
+        lsids: List[str],
+        children: bool = None,
+        container_path: str = None,
+        cpas_type: str = None,
+        exp_type: str = None,
+        depth: int = None,
+        include_properties: bool = None,
+        include_inputs_and_outputs: bool = None,
+        include_run_steps: bool = None,
+        parents: bool = None,
+        run_protocol_lsid: str = None,
+    ):
+        return lineage(
+            self.server_context,
+            lsids,
+            children,
+            container_path,
+            cpas_type,
+            depth,
+            exp_type,
+            parents,
+            include_inputs_and_outputs,
+            include_properties,
+            include_run_steps,
+            run_protocol_lsid,
+        )

{labkey-3.1.0.dist-info → labkey-3.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: labkey
-Version: 3.1.0
+Version: 3.2.0
 Summary: Python client API for LabKey Server
 Home-page: https://github.com/LabKey/labkey-api-python
 Author: LabKey
@@ -21,6 +21,17 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering
 License-File: LICENSE.txt
 Requires-Dist: requests
+Provides-Extra: build
+Requires-Dist: setuptools ; extra == 'build'
+Requires-Dist: build ; extra == 'build'
+Requires-Dist: twine ; extra == 'build'
+Requires-Dist: wheel ; extra == 'build'
+Provides-Extra: dev
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: requests ; extra == 'dev'
+Requires-Dist: mock ; extra == 'dev'
+Requires-Dist: pytest-cov ; extra == 'dev'
+Requires-Dist: black ; extra == 'dev'
 Provides-Extra: test
 Requires-Dist: pytest ; extra == 'test'
 Requires-Dist: requests ; extra == 'test'

{labkey-3.1.0.dist-info → labkey-3.2.0.dist-info}/RECORD

@@ -1,16 +1,16 @@
-labkey/__init__.py,sha256=SjBskVArzIGzH9aIlUwSK246XoguCK7iCvEm0fXQAhQ,695
+labkey/__init__.py,sha256=BxplFb91voofYbNkCpovsh5LfOdvBLWqCmHPjhy2Lj0,695
 labkey/api_wrapper.py,sha256=OxnV6_5jONWiwsi24TOXTKP5inXtAfABGqXAPua3eCM,1427
 labkey/container.py,sha256=DXmLhGsNnN_QLXa_tMCM0Xf_Kkz7B8KjRFhJT5I4FtY,5497
 labkey/domain.py,sha256=SABG7BfSqQGJr8DPjUsvhi8C7xP2MTpkq24sdtAu4J8,22486
 labkey/exceptions.py,sha256=00x-4oP_2d0SfZKxsGIs8QGvXiNq2y7C5hAzuzT3Gkk,3619
-labkey/experiment.py,sha256=Wtuz52bhuvDWk_o2AbTw7SJnwEji2iD6Q04ct0PWSxE,8804
+labkey/experiment.py,sha256=6U4BXnYHNXCUF_mee0maK_CZDVm_lbMjC82ywx9YCTE,12062
 labkey/query.py,sha256=w6vYDwiwnLalrDQ8pGY-c9DvoPQuMXaFXnZLRUiezuk,24041
 labkey/security.py,sha256=eMa2b_22FWB2rVvVpxTeWrK0VgGTszhRchsApbDR6sA,15306
 labkey/server_context.py,sha256=0YcA7BRijLMs172qTrTB12MlnIcqz4X9dkkCwSxxzaA,7741
 labkey/storage.py,sha256=WpgpTWQzgig_qJXMGszFcFjtf8oMd2-6TBehSkpJPUg,6144
 labkey/utils.py,sha256=oL6qmHkpzLTm_9c7gSEzumv_MVh5s8fj6bOrbuslrV0,3233
-labkey-3.1.0.dist-info/LICENSE.txt,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
-labkey-3.1.0.dist-info/METADATA,sha256=8O6aEerFp6Qn5B18KBaa7GGKApoNCwDDWDpaB9atXwM,1076
-labkey-3.1.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-labkey-3.1.0.dist-info/top_level.txt,sha256=DQIk1fQNg7NxxBsEt_K7k-aopiH87jmnU98zwDp0n04,7
-labkey-3.1.0.dist-info/RECORD,,
+labkey-3.2.0.dist-info/LICENSE.txt,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
+labkey-3.2.0.dist-info/METADATA,sha256=0xOPpsSbHkT9ow_bUQeILdYVPAcFIwmr_KG1tlHHbxQ,1481
+labkey-3.2.0.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+labkey-3.2.0.dist-info/top_level.txt,sha256=DQIk1fQNg7NxxBsEt_K7k-aopiH87jmnU98zwDp0n04,7
+labkey-3.2.0.dist-info/RECORD,,

{labkey-3.1.0.dist-info → labkey-3.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (74.1.2)
 Root-Is-Purelib: true
 Tag: py3-none-any