pipekit-sdk 2.0.1__tar.gz → 2.1.2__tar.gz

{pipekit_sdk-2.0.1 → pipekit_sdk-2.1.2}/PKG-INFO

@@ -1,25 +1,28 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pipekit-sdk
-Version: 2.0.1
+Version: 2.1.2
 Summary: Pipekit Python SDK
-Home-page: https://pipekit.io
 License: BSD-3-Clause
+License-File: LICENSE
 Keywords: pipekit,hera,argo,workflows,orchestration
 Author: Pipekit
 Author-email: ci@pipekit.io
-Requires-Python: >=3.8,<4
+Requires-Python: >=3.9,<4
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: hera (>=5.5.2)
 Requires-Dist: pydantic (<3)
+Requires-Dist: pyjwt (>=2.9.0,<3.0.0)
 Requires-Dist: responses (>=0.25.3,<0.26.0)
 Project-URL: Documentation, https://docs.pipekit.io/
+Project-URL: Homepage, https://pipekit.io
 Description-Content-Type: text/markdown
 
 [![Pipekit Logo](https://helm.pipekit.io/assets/pipekit-logo.png)](https://pipekit.io)
@@ -94,6 +97,45 @@ pipekit.submit(w, "<cluster-name>")
 pipekit.print_logs(pipe_run.uuid)
 ```
 
+## Managing CronWorkflows
+
+You can create, update, and delete a `CronWorkflow` from Python. The namespace
+must match the one in the manifest on every call (the platform default is
+`argo`). A wrong namespace makes the cron look missing.
+
+```py
+from hera.workflows import Container, CronWorkflow
+from pipekit_sdk.service import PipekitService
+
+pipekit = PipekitService(token="<token>")
+
+with CronWorkflow(
+    name="daily-demand-forecast",
+    namespace="argo",
+    entrypoint="main",
+    # Argo Workflows 3.6 deprecated the singular spec.schedule. Use schedules.
+    schedules=["*/5 * * * *"],
+    service_account_name="argo",
+) as cron:
+    Container(name="main", image="alpine", command=["sh", "-c", "echo hello"])
+
+# Create
+pipekit.create(cron, "<cluster-name>")
+
+# Update: the namespace is taken from the manifest when not passed
+updated = pipekit.update_cron(cron, "<cluster-name>")
+
+# Suspend / resume scheduling
+pipekit.suspend_cron("<cluster-name>", "argo", "daily-demand-forecast")
+pipekit.resume_cron("<cluster-name>", "argo", "daily-demand-forecast")
+
+# Get the current state
+current = pipekit.get_cron("<cluster-name>", "argo", "daily-demand-forecast")
+
+# Delete
+pipekit.delete_cron("<cluster-name>", "argo", "daily-demand-forecast")
+```
+
 ## Further help
 Please refer to the [Pipekit Documentation](https://docs.pipekit.io) for more information.
 

{pipekit_sdk-2.0.1 → pipekit_sdk-2.1.2}/README.md

@@ -70,5 +70,44 @@ pipekit.submit(w, "<cluster-name>")
 pipekit.print_logs(pipe_run.uuid)
 ```
 
+## Managing CronWorkflows
+
+You can create, update, and delete a `CronWorkflow` from Python. The namespace
+must match the one in the manifest on every call (the platform default is
+`argo`). A wrong namespace makes the cron look missing.
+
+```py
+from hera.workflows import Container, CronWorkflow
+from pipekit_sdk.service import PipekitService
+
+pipekit = PipekitService(token="<token>")
+
+with CronWorkflow(
+    name="daily-demand-forecast",
+    namespace="argo",
+    entrypoint="main",
+    # Argo Workflows 3.6 deprecated the singular spec.schedule. Use schedules.
+    schedules=["*/5 * * * *"],
+    service_account_name="argo",
+) as cron:
+    Container(name="main", image="alpine", command=["sh", "-c", "echo hello"])
+
+# Create
+pipekit.create(cron, "<cluster-name>")
+
+# Update: the namespace is taken from the manifest when not passed
+updated = pipekit.update_cron(cron, "<cluster-name>")
+
+# Suspend / resume scheduling
+pipekit.suspend_cron("<cluster-name>", "argo", "daily-demand-forecast")
+pipekit.resume_cron("<cluster-name>", "argo", "daily-demand-forecast")
+
+# Get the current state
+current = pipekit.get_cron("<cluster-name>", "argo", "daily-demand-forecast")
+
+# Delete
+pipekit.delete_cron("<cluster-name>", "argo", "daily-demand-forecast")
+```
+
 ## Further help
 Please refer to the [Pipekit Documentation](https://docs.pipekit.io) for more information.

{pipekit_sdk-2.0.1 → pipekit_sdk-2.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pipekit-sdk"
-version = "2.0.1"
+version = "2.1.2"
 description = "Pipekit Python SDK"
 authors = ["Pipekit <ci@pipekit.io>"]
 license = "BSD-3-Clause"
@@ -23,10 +23,11 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = ">=3.8,<4"
+python = ">=3.9,<4"
 hera = ">=5.5.2"
 pydantic = "<3"
 responses = "^0.25.3"
+pyjwt = "^2.9.0"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "*"
@@ -34,7 +35,7 @@ mypy = "^1.11.0"
 pytest = "^8.3.1"
 hera = {extras = ["cli"], version = "^5.16.1"}
 types-requests = "^2.32.0.20240712"
-datamodel-code-generator = {extras = ["http"], version = "^0.26.0"}
+datamodel-code-generator = {extras = ["http"], version = "^0.35.0"}
 
 [build-system]
 requires = ["poetry-core"]

{pipekit_sdk-2.0.1 → pipekit_sdk-2.1.2}/src/pipekit_sdk/models/v1.py

@@ -132,7 +132,7 @@ class AzureFileVolumeSource(BaseModel):
         str,
         Field(
             alias="secretName",
-            description=("secretName is the  name of secret that contains Azure Storage Account" " Name and Key"),
+            description=("secretName is the  name of secret that contains Azure Storage Account Name and Key"),
         ),
     ]
     share_name: Annotated[str, Field(alias="shareName", description="shareName is the azure share Name")]
@@ -182,7 +182,7 @@ class ContainerPort(BaseModel):
         Field(
             alias="containerPort",
             description=(
-                "Number of port to expose on the pod's IP address. This must be a valid" " port number, 0 < x < 65536."
+                "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536."
             ),
         ),
     ]
@@ -312,7 +312,7 @@ class FlockerVolumeSource(BaseModel):
         Optional[str],
         Field(
             alias="datasetUUID",
-            description=("datasetUUID is the UUID of the dataset. This is unique identifier of a" " Flocker dataset"),
+            description=("datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset"),
         ),
     ] = None
 
@@ -371,7 +371,7 @@ class GCEPersistentDiskVolumeSource(BaseModel):
 class GRPCAction(BaseModel):
     port: Annotated[
         int,
-        Field(description=("Port number of the gRPC service. Number must be in the range 1 to" " 65535.")),
+        Field(description=("Port number of the gRPC service. Number must be in the range 1 to 65535.")),
     ]
     service: Annotated[
         str,
@@ -613,7 +613,7 @@ class ObjectFieldSelector(BaseModel):
         Optional[str],
         Field(
             alias="apiVersion",
-            description=("Version of the schema the FieldPath is written in terms of, defaults" ' to "v1".'),
+            description=('Version of the schema the FieldPath is written in terms of, defaults to "v1".'),
         ),
     ] = None
     field_path: Annotated[
@@ -729,15 +729,11 @@ class OwnerReference(BaseModel):
     ]
     name: Annotated[
         str,
-        Field(
-            description=("Name of the referent. More info:" " http://kubernetes.io/docs/user-guide/identifiers#names")
-        ),
+        Field(description=("Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names")),
     ]
     uid: Annotated[
         str,
-        Field(
-            description=("UID of the referent. More info:" " http://kubernetes.io/docs/user-guide/identifiers#uids")
-        ),
+        Field(description=("UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids")),
     ]
 
 
@@ -757,7 +753,7 @@ class PersistentVolumeClaimVolumeSource(BaseModel):
         Optional[bool],
         Field(
             alias="readOnly",
-            description=("readOnly Will force the ReadOnly setting in VolumeMounts. Default" " false."),
+            description=("readOnly Will force the ReadOnly setting in VolumeMounts. Default false."),
         ),
     ] = None
 
@@ -826,9 +822,7 @@ class PreferredSchedulingTerm(BaseModel):
     ]
     weight: Annotated[
         int,
-        Field(
-            description=("Weight associated with matching the corresponding nodeSelectorTerm, in" " the range 1-100.")
-        ),
+        Field(description=("Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.")),
     ]
 
 
@@ -872,7 +866,7 @@ class QuobyteVolumeSource(BaseModel):
     ] = None
     volume: Annotated[
         str,
-        Field(description=("volume is a string that references an already created Quobyte volume" " by name.")),
+        Field(description=("volume is a string that references an already created Quobyte volume by name.")),
     ]
 
 
@@ -894,8 +888,7 @@ class RBDVolumeSource(BaseModel):
         str,
         Field(
             description=(
-                "image is the rados image name. More info:"
-                " https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"
+                "image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"
             )
         ),
     ]
@@ -999,9 +992,7 @@ class ScaleIOVolumeSource(BaseModel):
         Optional[str],
         Field(
             alias="protectionDomain",
-            description=(
-                "protectionDomain is the name of the ScaleIO Protection Domain for the" " configured storage."
-            ),
+            description=("protectionDomain is the name of the ScaleIO Protection Domain for the configured storage."),
         ),
     ] = None
     read_only: Annotated[
@@ -1029,7 +1020,7 @@ class ScaleIOVolumeSource(BaseModel):
         Optional[bool],
         Field(
             alias="sslEnabled",
-            description=("sslEnabled Flag enable/disable SSL communication with Gateway, default" " false"),
+            description=("sslEnabled Flag enable/disable SSL communication with Gateway, default false"),
         ),
     ] = None
     storage_mode: Annotated[
@@ -1046,7 +1037,7 @@ class ScaleIOVolumeSource(BaseModel):
         Optional[str],
         Field(
             alias="storagePool",
-            description=("storagePool is the ScaleIO Storage Pool associated with the protection" " domain."),
+            description=("storagePool is the ScaleIO Storage Pool associated with the protection domain."),
         ),
     ] = None
     system: Annotated[
@@ -1231,7 +1222,7 @@ class ServiceAccountTokenProjection(BaseModel):
     ] = None
     path: Annotated[
         str,
-        Field(description=("path is the path relative to the mount point of the file to project" " the token into.")),
+        Field(description=("path is the path relative to the mount point of the file to project the token into.")),
     ]
 
 
@@ -1396,7 +1387,7 @@ class VolumeDevice(BaseModel):
         str,
         Field(
             alias="devicePath",
-            description=("devicePath is the path inside of the container that the device will be" " mapped to."),
+            description=("devicePath is the path inside of the container that the device will be mapped to."),
         ),
     ]
     name: Annotated[
@@ -1410,7 +1401,7 @@ class VolumeMount(BaseModel):
         str,
         Field(
             alias="mountPath",
-            description=("Path within the container at which the volume should be mounted.  Must" " not contain ':'."),
+            description=("Path within the container at which the volume should be mounted.  Must not contain ':'."),
         ),
     ]
     mount_propagation: Annotated[
@@ -1429,9 +1420,7 @@ class VolumeMount(BaseModel):
         Optional[bool],
         Field(
             alias="readOnly",
-            description=(
-                "Mounted read-only if true, read-write otherwise (false or" " unspecified). Defaults to false."
-            ),
+            description=("Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."),
         ),
     ] = None
     sub_path: Annotated[
@@ -1485,7 +1474,7 @@ class VsphereVirtualDiskVolumeSource(BaseModel):
         Optional[str],
         Field(
             alias="storagePolicyName",
-            description=("storagePolicyName is the storage Policy Based Management (SPBM)" " profile name."),
+            description=("storagePolicyName is the storage Policy Based Management (SPBM) profile name."),
         ),
     ] = None
     volume_path: Annotated[
@@ -1589,7 +1578,7 @@ class CSIVolumeSource(BaseModel):
         Field(
             alias="readOnly",
             description=(
-                "readOnly specifies a read-only configuration for the volume. Defaults" " to false (read/write)."
+                "readOnly specifies a read-only configuration for the volume. Defaults to false (read/write)."
             ),
         ),
     ] = None
@@ -1619,7 +1608,7 @@ class CephFSVolumeSource(BaseModel):
     path: Annotated[
         Optional[str],
         Field(
-            description=("path is Optional: Used as the mounted root, rather than the full Ceph" " tree, default is /")
+            description=("path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /")
         ),
     ] = None
     read_only: Annotated[
@@ -1695,8 +1684,7 @@ class CinderVolumeSource(BaseModel):
         Field(
             alias="secretRef",
             description=(
-                "secretRef is optional: points to a secret object containing parameters"
-                " used to connect to OpenStack."
+                "secretRef is optional: points to a secret object containing parameters used to connect to OpenStack."
             ),
         ),
     ] = None
@@ -1825,9 +1813,7 @@ class EnvFromSource(BaseModel):
     ] = None
     prefix: Annotated[
         Optional[str],
-        Field(
-            description=("An optional identifier to prepend to each key in the ConfigMap. Must" " be a C_IDENTIFIER.")
-        ),
+        Field(description=("An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.")),
     ] = None
     secret_ref: Annotated[
         Optional[SecretEnvSource],
@@ -1918,14 +1904,14 @@ class ISCSIVolumeSource(BaseModel):
         Optional[bool],
         Field(
             alias="chapAuthDiscovery",
-            description=("chapAuthDiscovery defines whether support iSCSI Discovery CHAP" " authentication"),
+            description=("chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication"),
         ),
     ] = None
     chap_auth_session: Annotated[
         Optional[bool],
         Field(
             alias="chapAuthSession",
-            description=("chapAuthSession defines whether support iSCSI Session CHAP" " authentication"),
+            description=("chapAuthSession defines whether support iSCSI Session CHAP authentication"),
         ),
     ] = None
     fs_type: Annotated[
@@ -1958,7 +1944,7 @@ class ISCSIVolumeSource(BaseModel):
         Field(
             alias="iscsiInterface",
             description=(
-                "iscsiInterface is the interface Name that uses an iSCSI transport." " Defaults to 'default' (tcp)."
+                "iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp)."
             ),
         ),
     ] = None
@@ -1977,14 +1963,14 @@ class ISCSIVolumeSource(BaseModel):
         Optional[bool],
         Field(
             alias="readOnly",
-            description=("readOnly here will force the ReadOnly setting in VolumeMounts." " Defaults to false."),
+            description=("readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false."),
         ),
     ] = None
     secret_ref: Annotated[
         Optional[LocalObjectReference],
         Field(
             alias="secretRef",
-            description=("secretRef is the CHAP Secret for iSCSI target and initiator" " authentication"),
+            description=("secretRef is the CHAP Secret for iSCSI target and initiator authentication"),
         ),
     ] = None
     target_portal: Annotated[
@@ -2005,7 +1991,7 @@ class LabelSelector(BaseModel):
         Optional[List[LabelSelectorRequirement]],
         Field(
             alias="matchExpressions",
-            description=("matchExpressions is a list of label selector requirements. The" " requirements are ANDed."),
+            description=("matchExpressions is a list of label selector requirements. The requirements are ANDed."),
         ),
     ] = None
     match_labels: Annotated[
@@ -2072,7 +2058,7 @@ class ManagedFieldsEntry(BaseModel):
         Optional[FieldsV1],
         Field(
             alias="fieldsV1",
-            description=("FieldsV1 holds the first JSON version format as described in the" ' "FieldsV1" type.'),
+            description=('FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.'),
         ),
     ] = None
     manager: Annotated[
@@ -2342,7 +2328,7 @@ class ObjectMeta(BaseModel):
         Field(
             alias="selfLink",
             description=(
-                "Deprecated: selfLink is a legacy read-only field that is no longer" " populated by the system."
+                "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system."
             ),
         ),
     ] = None
@@ -2372,12 +2358,12 @@ class PersistentVolumeClaimCondition(BaseModel):
         Optional[Time],
         Field(
             alias="lastTransitionTime",
-            description=("lastTransitionTime is the time the condition transitioned from one" " status to another."),
+            description=("lastTransitionTime is the time the condition transitioned from one status to another."),
         ),
     ] = None
     message: Annotated[
         Optional[str],
-        Field(description=("message is the human-readable message indicating details about last" " transition.")),
+        Field(description=("message is the human-readable message indicating details about last transition.")),
     ] = None
     reason: Annotated[
         Optional[str],
@@ -2754,7 +2740,7 @@ class Probe(BaseModel):
         Optional[int],
         Field(
             alias="periodSeconds",
-            description=("How often (in seconds) to perform the probe. Default to 10 seconds." " Minimum value is 1."),
+            description=("How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."),
         ),
     ] = None
     success_threshold: Annotated[
@@ -2996,14 +2982,12 @@ class WeightedPodAffinityTerm(BaseModel):
         PodAffinityTerm,
         Field(
             alias="podAffinityTerm",
-            description=("Required. A pod affinity term, associated with the corresponding" " weight."),
+            description=("Required. A pod affinity term, associated with the corresponding weight."),
         ),
     ]
     weight: Annotated[
         int,
-        Field(
-            description=("weight associated with matching the corresponding podAffinityTerm, in" " the range 1-100.")
-        ),
+        Field(description=("weight associated with matching the corresponding podAffinityTerm, in the range 1-100.")),
     ]
 
 
@@ -3013,7 +2997,7 @@ class DownwardAPIVolumeFile(BaseModel):
         Field(
             alias="fieldRef",
             description=(
-                "Required: Selects a field of the pod: only annotations, labels, name" " and namespace are supported."
+                "Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."
             ),
         ),
     ] = None
@@ -3279,7 +3263,7 @@ class PersistentVolumeClaimSpec(BaseModel):
         Optional[str],
         Field(
             alias="volumeName",
-            description=("volumeName is the binding reference to the PersistentVolume backing" " this claim."),
+            description=("volumeName is the binding reference to the PersistentVolume backing this claim."),
         ),
     ] = None
 
@@ -3442,7 +3426,7 @@ class EnvVar(BaseModel):
         Optional[EnvVarSource],
         Field(
             alias="valueFrom",
-            description=("Source for the environment variable's value. Cannot be used if value" " is not empty."),
+            description=("Source for the environment variable's value. Cannot be used if value is not empty."),
         ),
     ] = None
 
@@ -3552,7 +3536,7 @@ class VolumeProjection(BaseModel):
         Optional[ServiceAccountTokenProjection],
         Field(
             alias="serviceAccountToken",
-            description=("serviceAccountToken is information about the serviceAccountToken data" " to project"),
+            description=("serviceAccountToken is information about the serviceAccountToken data to project"),
         ),
     ] = None
 
@@ -3593,7 +3577,7 @@ class Container(BaseModel):
     ] = None
     env: Annotated[
         Optional[List[EnvVar]],
-        Field(description=("List of environment variables to set in the container. Cannot be" " updated.")),
+        Field(description=("List of environment variables to set in the container. Cannot be updated.")),
     ] = None
     env_from: Annotated[
         Optional[List[EnvFromSource]],
@@ -3795,14 +3779,14 @@ class Container(BaseModel):
         Optional[List[VolumeDevice]],
         Field(
             alias="volumeDevices",
-            description=("volumeDevices is the list of block devices to be used by the" " container."),
+            description=("volumeDevices is the list of block devices to be used by the container."),
         ),
     ] = None
     volume_mounts: Annotated[
         Optional[List[VolumeMount]],
         Field(
             alias="volumeMounts",
-            description=("Pod volumes to mount into the container's filesystem. Cannot be" " updated."),
+            description=("Pod volumes to mount into the container's filesystem. Cannot be updated."),
         ),
     ] = None
     working_dir: Annotated[
@@ -3856,19 +3840,19 @@ class Volume(BaseModel):
         Optional[AzureDiskVolumeSource],
         Field(
             alias="azureDisk",
-            description=("azureDisk represents an Azure Data Disk mount on the host and bind" " mount to the pod."),
+            description=("azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."),
         ),
     ] = None
     azure_file: Annotated[
         Optional[AzureFileVolumeSource],
         Field(
             alias="azureFile",
-            description=("azureFile represents an Azure File Service mount on the host and bind" " mount to the pod."),
+            description=("azureFile represents an Azure File Service mount on the host and bind mount to the pod."),
         ),
     ] = None
     cephfs: Annotated[
         Optional[CephFSVolumeSource],
-        Field(description=("cephFS represents a Ceph FS mount on the host that shares a pod's" " lifetime")),
+        Field(description=("cephFS represents a Ceph FS mount on the host that shares a pod's lifetime")),
     ] = None
     cinder: Annotated[
         Optional[CinderVolumeSource],
@@ -3900,7 +3884,7 @@ class Volume(BaseModel):
         Optional[DownwardAPIVolumeSource],
         Field(
             alias="downwardAPI",
-            description=("downwardAPI represents downward API about the pod that should populate" " this volume"),
+            description=("downwardAPI represents downward API about the pod that should populate this volume"),
         ),
     ] = None
     empty_dir: Annotated[
@@ -4065,18 +4049,16 @@ class Volume(BaseModel):
         Optional[PortworxVolumeSource],
         Field(
             alias="portworxVolume",
-            description=(
-                "portworxVolume represents a portworx volume attached and mounted on" " kubelets host machine"
-            ),
+            description=("portworxVolume represents a portworx volume attached and mounted on kubelets host machine"),
         ),
     ] = None
     projected: Annotated[
         Optional[ProjectedVolumeSource],
-        Field(description=("projected items for all in one resources secrets, configmaps, and" " downward API")),
+        Field(description=("projected items for all in one resources secrets, configmaps, and downward API")),
     ] = None
     quobyte: Annotated[
         Optional[QuobyteVolumeSource],
-        Field(description=("quobyte represents a Quobyte mount on the host that shares a pod's" " lifetime")),
+        Field(description=("quobyte represents a Quobyte mount on the host that shares a pod's lifetime")),
     ] = None
     rbd: Annotated[
         Optional[RBDVolumeSource],
@@ -4092,9 +4074,7 @@ class Volume(BaseModel):
         Optional[ScaleIOVolumeSource],
         Field(
             alias="scaleIO",
-            description=(
-                "scaleIO represents a ScaleIO persistent volume attached and mounted on" " Kubernetes nodes."
-            ),
+            description=("scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."),
         ),
     ] = None
     secret: Annotated[
@@ -4108,12 +4088,12 @@ class Volume(BaseModel):
     ] = None
     storageos: Annotated[
         Optional[StorageOSVolumeSource],
-        Field(description=("storageOS represents a StorageOS volume attached and mounted on" " Kubernetes nodes.")),
+        Field(description=("storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.")),
     ] = None
     vsphere_volume: Annotated[
         Optional[VsphereVirtualDiskVolumeSource],
         Field(
             alias="vsphereVolume",
-            description=("vsphereVolume represents a vSphere volume attached and mounted on" " kubelets host machine"),
+            description=("vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"),
         ),
     ] = None

{pipekit_sdk-2.0.1 → pipekit_sdk-2.1.2}/src/pipekit_sdk/models/v1alpha1.py

@@ -581,7 +581,7 @@ class ContainerNode(BaseModel):
     dependencies: Optional[List[str]] = None
     env: Annotated[
         Optional[List[v1.EnvVar]],
-        Field(description=("List of environment variables to set in the container. Cannot be" " updated.")),
+        Field(description=("List of environment variables to set in the container. Cannot be updated.")),
     ] = None
     env_from: Annotated[
         Optional[List[v1.EnvFromSource]],
@@ -783,14 +783,14 @@ class ContainerNode(BaseModel):
         Optional[List[v1.VolumeDevice]],
         Field(
             alias="volumeDevices",
-            description=("volumeDevices is the list of block devices to be used by the" " container."),
+            description=("volumeDevices is the list of block devices to be used by the container."),
         ),
     ] = None
     volume_mounts: Annotated[
         Optional[List[v1.VolumeMount]],
         Field(
             alias="volumeMounts",
-            description=("Pod volumes to mount into the container's filesystem. Cannot be" " updated."),
+            description=("Pod volumes to mount into the container's filesystem. Cannot be updated."),
         ),
     ] = None
     working_dir: Annotated[
@@ -854,7 +854,7 @@ class ScriptTemplate(BaseModel):
     ] = None
     env: Annotated[
         Optional[List[v1.EnvVar]],
-        Field(description=("List of environment variables to set in the container. Cannot be" " updated.")),
+        Field(description=("List of environment variables to set in the container. Cannot be updated.")),
     ] = None
     env_from: Annotated[
         Optional[List[v1.EnvFromSource]],
@@ -1057,14 +1057,14 @@ class ScriptTemplate(BaseModel):
         Optional[List[v1.VolumeDevice]],
         Field(
             alias="volumeDevices",
-            description=("volumeDevices is the list of block devices to be used by the" " container."),
+            description=("volumeDevices is the list of block devices to be used by the container."),
         ),
     ] = None
     volume_mounts: Annotated[
         Optional[List[v1.VolumeMount]],
         Field(
             alias="volumeMounts",
-            description=("Pod volumes to mount into the container's filesystem. Cannot be" " updated."),
+            description=("Pod volumes to mount into the container's filesystem. Cannot be updated."),
         ),
     ] = None
     working_dir: Annotated[
@@ -1116,7 +1116,7 @@ class UserContainer(BaseModel):
     ] = None
     env: Annotated[
         Optional[List[v1.EnvVar]],
-        Field(description=("List of environment variables to set in the container. Cannot be" " updated.")),
+        Field(description=("List of environment variables to set in the container. Cannot be updated.")),
     ] = None
     env_from: Annotated[
         Optional[List[v1.EnvFromSource]],
@@ -1319,14 +1319,14 @@ class UserContainer(BaseModel):
         Optional[List[v1.VolumeDevice]],
         Field(
             alias="volumeDevices",
-            description=("volumeDevices is the list of block devices to be used by the" " container."),
+            description=("volumeDevices is the list of block devices to be used by the container."),
         ),
     ] = None
     volume_mounts: Annotated[
         Optional[List[v1.VolumeMount]],
         Field(
             alias="volumeMounts",
-            description=("Pod volumes to mount into the container's filesystem. Cannot be" " updated."),
+            description=("Pod volumes to mount into the container's filesystem. Cannot be updated."),
         ),
     ] = None
     working_dir: Annotated[

{pipekit_sdk-2.0.1 → pipekit_sdk-2.1.2}/src/pipekit_sdk/service.py

@@ -2,19 +2,74 @@
 
 import json
 import os
-from typing import Any, Generator, Optional, cast
+from datetime import datetime
+from enum import Enum
+from pathlib import Path
+from typing import Any, Generator, List, Optional, cast
 
+import jwt
 import requests
 from hera.workflows import CronWorkflow, Workflow
-from hera.workflows.models import WorkflowCreateRequest
+from hera.workflows.models import CronWorkflow as CronWorkflowModel
+from hera.workflows.models import UpdateCronWorkflowRequest, WorkflowCreateRequest
+from pydantic import BaseModel, ValidationError
 
 from pipekit_sdk._helpers import is_valid_uuid
 from pipekit_sdk.models.model import Cluster, Logs, Pipe, PipeRun
 
+_CONTENT_TYPE_JSON = "application/json"
+
+
+class _LoginResponse(BaseModel):
+    """LoginResponse is a model for Login responses."""
+
+    token_type: str
+    access_token: str
+    expires_in: int
+    refresh_token: str
+
+
+class _AccessToken(BaseModel):
+    """AccessToken is a model for decoded access tokens."""
+
+    identityUUID: str
+    ClusterUUID: str
+    OrgUUID: str
+    isActive: bool
+    products: List[str]
+    iss: str
+    sub: str
+    exp: int
+
+
+class _ValidationResult(Enum):
+    OK = 0
+    INVALID_TOKEN = 1
+    EXPIRED_TOKEN = 2
+
 
 class PipekitService:
     """PipekitService is a wrapper around the Pipekit API. It provides a simple interface to interact with Pipekit."""
 
+    @staticmethod
+    def __from_home_dir() -> Optional[_LoginResponse]:
+        home = Path.home()
+        pipekit_token_file_path = os.path.join(home, ".pipekit", "token")
+        try:
+            with open(pipekit_token_file_path, "r") as f:
+                raw_data = f.read()
+                return _LoginResponse.model_validate_json(raw_data)
+        except ValidationError:
+            return None
+
+    @staticmethod
+    def __write_home_dir(login_resp: _LoginResponse):
+        home = Path.home()
+        pipekit_token_file_path = os.path.join(home, ".pipekit", "token")
+        with open(pipekit_token_file_path, "w") as f:
+            payload = login_resp.model_dump_json(indent=2)
+            f.write(payload)
+
     def __init__(
         self,
         username: str = "",
@@ -38,8 +93,60 @@ class PipekitService:
             self.access_token = token
             return
 
+        maybe_resp = self.__from_home_dir()
+        self.token_data = maybe_resp
+
+        if self.token_data is not None:
+            self.__token_login_flow()
+            return
+
         self.__login()
 
+    def __update_token(self) -> None:
+        login_url = f"{self.id_url}/api/id/v1/oauth/token"
+        assert self.token_data is not None, "Token data was None, this implies a bug"
+        login_request = {"grant_type": "refresh_token", "refresh_token": self.token_data.refresh_token}
+        login_response = requests.post(
+            login_url,
+            data=json.dumps(login_request),
+            headers={"Content-Type": _CONTENT_TYPE_JSON},
+            timeout=10,
+        )
+        if login_response.status_code // 100 != 2:
+            raise Exception(
+                "Couldn't refresh access token, obtained non 2xx status code, try logging in again via the cli"
+            )
+
+        login_response_model = _LoginResponse.model_validate(login_response.json())
+        self.__write_home_dir(login_response_model)
+        self.access_token = login_response_model.access_token
+
+    def __validate_token(self) -> _ValidationResult:
+        assert self.token_data is not None
+        try:
+            decoded_payload = jwt.decode(self.token_data.access_token, options={"verify_signature": False})
+            acc_tk = _AccessToken.model_validate(decoded_payload)
+            exp_time = datetime.fromtimestamp(acc_tk.exp)
+            now_time = datetime.now()
+
+            if exp_time <= now_time:
+                return _ValidationResult.EXPIRED_TOKEN
+        except jwt.PyJWTError:
+            return _ValidationResult.INVALID_TOKEN
+        return _ValidationResult.OK
+
+    def __token_login_flow(self) -> None:
+        assert self.token_data is not None, "token was None when it was expected to be valid"
+        res = self.__validate_token()
+        if res == _ValidationResult.EXPIRED_TOKEN:
+            self.__update_token()
+        elif res == _ValidationResult.INVALID_TOKEN:
+            raise RuntimeError(
+                "Token was invalid, if the `.pipekit/token` file is corrupted, please delete the file and login again"
+            )
+        else:
+            self.access_token = self.token_data.access_token
+
     def __login(self) -> None:
         login_request = {
             "username": self.username,
@@ -55,7 +162,7 @@ class PipekitService:
         login_response = requests.post(
             login_url,
             data=json.dumps(login_request),
-            headers={"Content-Type": "application/json"},
+            headers={"Content-Type": _CONTENT_TYPE_JSON},
             timeout=10,
         )
 
@@ -255,6 +362,14 @@ class PipekitService:
 
         return None
 
+    def __resolve_cluster_uuid(self, cluster: str) -> str:
+        """Return the cluster UUID for a cluster name, or pass through a UUID unchanged."""
+        if is_valid_uuid(cluster):
+            return cluster
+        if cluster_obj := self.get_cluster_by_name(cluster):
+            return cluster_obj.uuid
+        raise ValueError(f"No cluster found for {cluster}")
+
     def submit(
         self,
         workflow: Workflow,
@@ -262,11 +377,7 @@ class PipekitService:
         pipe_name: str = "",
     ) -> PipeRun:
         """Submit a Workflow to a cluster, under an existing or new pipe with the given name."""
-        if not is_valid_uuid(cluster):
-            if cluster_obj := self.get_cluster_by_name(cluster):
-                cluster = cluster_obj.uuid
-            else:
-                raise ValueError(f"No cluster found for {cluster}")
+        cluster = self.__resolve_cluster_uuid(cluster)
 
         submit_url = f"{self.users_url}/api/users/v1/clusters/{cluster}/workflows"
         if pipe_name != "":
@@ -285,7 +396,7 @@ class PipekitService:
             ),
             headers={
                 "Authorization": f"Bearer {self.access_token}",
-                "Content-Type": "application/json",
+                "Content-Type": _CONTENT_TYPE_JSON,
             },
             timeout=10,
         )
@@ -297,11 +408,7 @@ class PipekitService:
 
     def create(self, cron_workflow: CronWorkflow, cluster: str, pipe_name: str = "") -> PipeRun:
         """Create a CronWorkflow on the cluster, under an existing or new pipe with the given name."""
-        if not is_valid_uuid(cluster):
-            if cluster_obj := self.get_cluster_by_name(cluster):
-                cluster = cluster_obj.uuid
-            else:
-                raise ValueError(f"No cluster found for {cluster}")
+        cluster = self.__resolve_cluster_uuid(cluster)
 
         create_url = f"{self.users_url}/api/users/v1/clusters/{cluster}/cron-workflows"
         if pipe_name != "":
@@ -320,7 +427,7 @@ class PipekitService:
             ),
             headers={
                 "Authorization": f"Bearer {self.access_token}",
-                "Content-Type": "application/json",
+                "Content-Type": _CONTENT_TYPE_JSON,
             },
             timeout=10,
         )
@@ -330,6 +437,129 @@ class PipekitService:
 
         return PipeRun.model_validate(create_response.json())
 
+    @staticmethod
+    def __require_namespace(namespace: str) -> None:
+        # A cron lives in the namespace set on its manifest (the platform default
+        # is "argo"). An empty or wrong namespace makes the cron look missing, so
+        # we reject an empty namespace here instead of sending a request that
+        # returns a confusing "no rows" error.
+        if namespace == "":
+            raise ValueError(
+                "namespace is required and must match the CronWorkflow manifest namespace "
+                "(the platform default is 'argo')"
+            )
+
+    def __cron_workflow_url(self, cluster_uuid: str, namespace: str, name: str) -> str:
+        return f"{self.users_url}/api/users/v1/clusters/{cluster_uuid}/hera/api/v1/cron-workflows/{namespace}/{name}"
+
+    def __cron_request(self, method: str, url: str, action: str, data: Optional[str] = None) -> requests.Response:
+        # Shared HTTP call for the cron methods: attach auth, send, and turn a
+        # non-2xx status into an error. `action` names the operation in the
+        # error message (for example "Update").
+        headers = {"Authorization": f"Bearer {self.access_token}"}
+        if data is not None:
+            headers["Content-Type"] = _CONTENT_TYPE_JSON
+
+        response = requests.request(method, url, data=data, headers=headers, timeout=10)
+        if response.status_code // 100 != 2:
+            raise RuntimeError(f"{action} cron failed: {response.text}")
+
+        return response
+
+    def __cron_by_name(self, cluster: str, namespace: str, name: str) -> str:
+        # Validate the namespace, resolve the cluster name to a UUID, and return
+        # the cron URL. Shared by the methods that act on a cron by name.
+        self.__require_namespace(namespace)
+        cluster_uuid = self.__resolve_cluster_uuid(cluster)
+        return self.__cron_workflow_url(cluster_uuid, namespace, name)
+
+    def update_cron(
+        self,
+        cron_workflow: CronWorkflow,
+        cluster: str,
+        namespace: str = "",
+    ) -> CronWorkflowModel:
+        """Update an existing CronWorkflow's spec and return the updated object.
+
+        The namespace must match the one in the CronWorkflow manifest. When
+        namespace is empty, it is taken from the CronWorkflow object.
+        """
+        if namespace == "":
+            namespace = cron_workflow.namespace or ""
+
+        name = cron_workflow.name
+        if not name:
+            raise ValueError("CronWorkflow metadata.name is required")
+
+        url = self.__cron_by_name(cluster, namespace, name)
+
+        built = cron_workflow.build()
+        assert built is not None
+        request = UpdateCronWorkflowRequest(
+            name=name,
+            namespace=namespace,
+            cron_workflow=built,  # type: ignore
+        )
+        body = request.json(exclude_none=True, by_alias=True, exclude_unset=True, exclude_defaults=True)
+
+        response = self.__cron_request("PUT", url, "Update", data=body)
+        return CronWorkflowModel.parse_raw(response.text)
+
+    def delete_cron(
+        self,
+        cluster: str,
+        namespace: str,
+        name: str,
+    ) -> None:
+        """Delete a CronWorkflow by cluster, namespace, and name.
+
+        The namespace must match the CronWorkflow manifest namespace.
+        """
+        url = self.__cron_by_name(cluster, namespace, name)
+        self.__cron_request("DELETE", url, "Delete")
+
+    def get_cron(
+        self,
+        cluster: str,
+        namespace: str,
+        name: str,
+    ) -> CronWorkflowModel:
+        """Get a CronWorkflow by cluster, namespace, and name.
+
+        The namespace must match the CronWorkflow manifest namespace.
+        """
+        url = self.__cron_by_name(cluster, namespace, name)
+        response = self.__cron_request("GET", url, "Get")
+        return CronWorkflowModel.parse_raw(response.text)
+
+    def suspend_cron(
+        self,
+        cluster: str,
+        namespace: str,
+        name: str,
+    ) -> CronWorkflowModel:
+        """Suspend a CronWorkflow so it stops scheduling new runs.
+
+        The namespace must match the CronWorkflow manifest namespace.
+        """
+        url = self.__cron_by_name(cluster, namespace, name) + "/suspend"
+        response = self.__cron_request("PUT", url, "Suspend")
+        return CronWorkflowModel.parse_raw(response.text)
+
+    def resume_cron(
+        self,
+        cluster: str,
+        namespace: str,
+        name: str,
+    ) -> CronWorkflowModel:
+        """Resume a suspended CronWorkflow so it schedules runs again.
+
+        The namespace must match the CronWorkflow manifest namespace.
+        """
+        url = self.__cron_by_name(cluster, namespace, name) + "/resume"
+        response = self.__cron_request("PUT", url, "Resume")
+        return CronWorkflowModel.parse_raw(response.text)
+
     def __apply_run_action(
         self,
         run_uuid: str,
@@ -340,7 +570,7 @@ class PipekitService:
             action_url,
             headers={
                 "Authorization": f"Bearer {self.access_token}",
-                "Content-Type": "application/json",
+                "Content-Type": _CONTENT_TYPE_JSON,
             },
             timeout=10,
         )
@@ -374,13 +604,16 @@ class PipekitService:
     def __get_run_container_logs(
         self,
         run_uuid: str,
-        pod_name: str = "",
-        container_name: str = "",
+        pod_name: List[str] | str = [],
+        container_name: List[str] | str = [],
     ) -> list[Logs]:
-        logs_url = f"{self.users_url}/api/users/v1/runs/{run_uuid}/container_logs?pod-name={pod_name}&container-name={container_name}"
+        logs_url = f"{self.users_url}/api/users/v1/runs/{run_uuid}/container_logs"
 
+        # empty "" / [] must be omitted, not sent as ?pod-name= (the API filters to a pod named "")
+        params = {k: v for k, v in {"pod-name": pod_name, "container-name": container_name}.items() if v}
         logs_response = requests.get(
             logs_url,
+            params=params,
             headers={"Authorization": f"Bearer {self.access_token}"},
             timeout=10,
         )
@@ -393,14 +626,17 @@ class PipekitService:
     def __get_logs_stream(
         self,
         run_uuid: str,
-        pod_name: str = "",
-        container_name: str = "",
+        pod_name: List[str] | str = "",
+        container_name: List[str] | str = "",
         last_event_id: str = "",
     ) -> requests.Response:
-        logs_url = f"{self.users_url}/api/users/v1/runs/{run_uuid}/container_logs_stream?pod-name={pod_name}&container-name={container_name}"
+        logs_url = f"{self.users_url}/api/users/v1/runs/{run_uuid}/container_logs_stream"
 
+        # empty "" / [] must be omitted, not sent as ?pod-name= (the API filters to a pod named "")
+        params = {k: v for k, v in {"pod-name": pod_name, "container-name": container_name}.items() if v}
         logs_response = requests.get(
             logs_url,
+            params=params,
             stream=True,
             timeout=None,  # nosec B113
             headers={
@@ -419,8 +655,8 @@ class PipekitService:
     def get_logs(
         self,
         run_uuid: str,
-        pod_name: str = "",
-        container_name: str = "",
+        pod_name: List[str] | str = "",
+        container_name: List[str] | str = "",
     ) -> list[Logs]:
         """Get logs for a given run."""
         return self.__get_run_container_logs(run_uuid, pod_name, container_name)
@@ -428,8 +664,8 @@ class PipekitService:
     def follow_logs(
         self,
         run_uuid: str,
-        pod_name: str = "",
-        container_name: str = "",
+        pod_name: List[str] | str = "",
+        container_name: List[str] | str = "",
     ) -> Generator[Logs, Any, None]:
         """Return a generator that yields pod logs for a given run."""
         data_msg_prefix = "data: "
@@ -475,14 +711,19 @@ class PipekitService:
     def print_logs(
         self,
         run_uuid: str,
-        pod_name: str = "",
-        container_name: str = "",
+        pod_name: List[str] | str = "",
+        container_name: List[str] | str = "",
         follow: bool = True,
     ) -> None:
         """Print pod logs for a given run."""
         if follow:
             for log in self.follow_logs(run_uuid, pod_name=pod_name, container_name=container_name):
                 self.__print_log_message(log)
+            return
 
         for log in self.get_logs(run_uuid, pod_name=pod_name, container_name=container_name):
             self.__print_log_message(log)
+
+
+if __name__ == "__main__":
+    p = PipekitService()