kubernetes-watch 0.1.5__tar.gz → 0.1.9__tar.gz

{kubernetes_watch-0.1.5 → kubernetes_watch-0.1.9}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Benyamin Motevalli
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Benyamin Motevalli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{kubernetes_watch-0.1.5 → kubernetes_watch-0.1.9}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: kubernetes-watch
-Version: 0.1.5
+Version: 0.1.9
 Summary: 
 Author: bmotevalli
 Author-email: b.motevalli@gmail.com
-Requires-Python: >=3.10,<4
+Requires-Python: >=3.10,<3.14
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -15,7 +15,9 @@ Requires-Dist: boto3 (>=1.34.68,<2.0.0)
 Requires-Dist: humps (>=0.2.2,<0.3.0)
 Requires-Dist: hvac (>=2.1.0,<3.0.0)
 Requires-Dist: kubernetes (>=29.0.0,<30.0.0)
-Requires-Dist: prefect (>=2.18.0,<3.0.0)
+Requires-Dist: prefect (>=3.4.17,<4.0.0)
+Requires-Dist: psycopg2 (>=2.9.10,<3.0.0)
+Requires-Dist: pydantic (>=2.11.7,<3.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
 Description-Content-Type: text/markdown
 

{kubernetes_watch-0.1.5 → kubernetes_watch-0.1.9}/README.md

@@ -1,117 +1,117 @@
-# kube_watch
-
-# To setup the project:
-
-- `poetry install`
-- `poetry shell`
-
-# To install package to your environment locally:
-
-python setup.py install
-
-# To publish
-
-`poetry config pypi-token.pypi your-api-token`
-`poetry build`
-`poetry publish`
-
-
-# Description
-The kube_watch library is build on top of <a href='https://docs.prefect.io/latest/'>Prefect</a>. The library is designed to define workflows in a declaritive and flexible fashion. Originally, workflows in Prefect are defined via decorators such as @flow and @task. In kube_watch, workflows can be defined in a declaritive form via yaml files. The library is mainly focused on running scheduled workflows in kubernetes environment. However, it can easily be extended to be used for any purpose requiring a workflow. The workflow manifest has the following generic structure:
-
-```
-workflow:
-  name: Dummy Workflow
-  runner: concurrent
-  tasks:
-    - name: Task_A
-      module: <module_path>
-      task: <func_name>
-      inputsArgType: arg
-      inputs:
-        parameters:
-          - name: x1
-            value: y1
-          - name: x2
-            value: y2
-          - name: x3
-            type: env
-            value: Y3
-
-    - name: Task_B
-      module: <module_path>
-      task: <func_name>
-      inputsArgType: arg
-      inputs:
-        parameters:
-          - name: xx1
-            value: yy1
-          - name: xx2
-            value: yy2
-      dependency:
-        - taskName: Task_A
-          inputParamName: xx3
-
-    - name: Task_C
-      module: <module_path>
-      task: <func_name>
-      inputsArgType: arg
-      conditional:
-        tasks: ["Task_B"]
-```
-
-
-**runner**: concurrent | sequential: if concurrent selected, tasks will be run concurrently.
-
-**module**: all modules are located in 'modules' directory in kube_watch. This is where you can extend the library and add new tasks / modules. Below modules, there are submodules such as providers, clusters, and logic. Within each of this submodules, specific modules are defined. For example: providers.aws contains a series of tasks related to AWS. In this case, <module_path> = providers.aws. To add new tasks, add a new module with a similar pattern and refer the path in your task block. 
-
-**task**: task is simply the name function that you put in the <module_path>. i.e. as you define a function in a module, you can simply start to use it in your manifests.
-
-**inputArgType**: arg | dict | list: if the task functions accept known-fixed number of parameters, then use arg. 
-
-**dependency**: this block defines dependency of a child task to its parent. If **inputParamName** is defined, then OUTPUT of the parent task is passed to the child with an argument name defined by inputParamName.
-
-**IMPORTATN NOTE**: A strict assumption is that task functions return a single output. If there are cases with multiple output, wrap them into a dictionary and unwrap them in the child task.
-
-**conditional**: These are blocks where you can define when a task runs depending on the outcome of its parent. The parent task should return True or False.
-
-
-Parameters have also a type entry: env | static. static is default value. If type is defined as env, the parameter value is loaded from Environment Variables. In this case, value should be the name of the corresponding env var. 
-
-In above examples:
-
-```
-def Task_A(x1, x2, x3):
-    # do something
-    return output_A
-
-def Task_B(xx1, xx2, xx3):
-    # do something else
-    return output_B
-
-def Task_C():
-    # do another thing
-    return output_C
-```
-
-
-
-# Batch workflows
-kube_watch also enables to run workflows in batch. A separate manifest with following form is required:
-
-batchFlows:
-  runner: sequential
-  items:
-    - path: path_to_flow_A.yaml
-    - path: path_to_flow_B.yaml
-    - path: path_to_flow_C.yaml
-
-
-# cron_app
-The cron_app folder contains an example use case of kube_watch library. The cron_app can be used to deploy a CronJob in a kubernetes environment. The app assumes the manifests are located in a separate repository. It will clone the repo and read the manifests and runs the workflows.
-
-# Connect to a server
-## Start Server
-`prefect server start`
-## To Connect
-To connect to a server, simply set the following environment variable: `PREFECT_API_URL`
+# kube_watch
+
+# To setup the project:
+
+- `poetry install`
+- `poetry shell`
+
+# To install package to your environment locally:
+
+python setup.py install
+
+# To publish
+
+`poetry config pypi-token.pypi your-api-token`
+`poetry build`
+`poetry publish`
+
+
+# Description
+The kube_watch library is build on top of <a href='https://docs.prefect.io/latest/'>Prefect</a>. The library is designed to define workflows in a declaritive and flexible fashion. Originally, workflows in Prefect are defined via decorators such as @flow and @task. In kube_watch, workflows can be defined in a declaritive form via yaml files. The library is mainly focused on running scheduled workflows in kubernetes environment. However, it can easily be extended to be used for any purpose requiring a workflow. The workflow manifest has the following generic structure:
+
+```
+workflow:
+  name: Dummy Workflow
+  runner: concurrent
+  tasks:
+    - name: Task_A
+      module: <module_path>
+      task: <func_name>
+      inputsArgType: arg
+      inputs:
+        parameters:
+          - name: x1
+            value: y1
+          - name: x2
+            value: y2
+          - name: x3
+            type: env
+            value: Y3
+
+    - name: Task_B
+      module: <module_path>
+      task: <func_name>
+      inputsArgType: arg
+      inputs:
+        parameters:
+          - name: xx1
+            value: yy1
+          - name: xx2
+            value: yy2
+      dependency:
+        - taskName: Task_A
+          inputParamName: xx3
+
+    - name: Task_C
+      module: <module_path>
+      task: <func_name>
+      inputsArgType: arg
+      conditional:
+        tasks: ["Task_B"]
+```
+
+
+**runner**: concurrent | sequential: if concurrent selected, tasks will be run concurrently.
+
+**module**: all modules are located in 'modules' directory in kube_watch. This is where you can extend the library and add new tasks / modules. Below modules, there are submodules such as providers, clusters, and logic. Within each of this submodules, specific modules are defined. For example: providers.aws contains a series of tasks related to AWS. In this case, <module_path> = providers.aws. To add new tasks, add a new module with a similar pattern and refer the path in your task block. 
+
+**task**: task is simply the name function that you put in the <module_path>. i.e. as you define a function in a module, you can simply start to use it in your manifests.
+
+**inputArgType**: arg | dict | list: if the task functions accept known-fixed number of parameters, then use arg. 
+
+**dependency**: this block defines dependency of a child task to its parent. If **inputParamName** is defined, then OUTPUT of the parent task is passed to the child with an argument name defined by inputParamName.
+
+**IMPORTATN NOTE**: A strict assumption is that task functions return a single output. If there are cases with multiple output, wrap them into a dictionary and unwrap them in the child task.
+
+**conditional**: These are blocks where you can define when a task runs depending on the outcome of its parent. The parent task should return True or False.
+
+
+Parameters have also a type entry: env | static. static is default value. If type is defined as env, the parameter value is loaded from Environment Variables. In this case, value should be the name of the corresponding env var. 
+
+In above examples:
+
+```
+def Task_A(x1, x2, x3):
+    # do something
+    return output_A
+
+def Task_B(xx1, xx2, xx3):
+    # do something else
+    return output_B
+
+def Task_C():
+    # do another thing
+    return output_C
+```
+
+
+
+# Batch workflows
+kube_watch also enables to run workflows in batch. A separate manifest with following form is required:
+
+batchFlows:
+  runner: sequential
+  items:
+    - path: path_to_flow_A.yaml
+    - path: path_to_flow_B.yaml
+    - path: path_to_flow_C.yaml
+
+
+# cron_app
+The cron_app folder contains an example use case of kube_watch library. The cron_app can be used to deploy a CronJob in a kubernetes environment. The app assumes the manifests are located in a separate repository. It will clone the repo and read the manifests and runs the workflows.
+
+# Connect to a server
+## Start Server
+`prefect server start`
+## To Connect
+To connect to a server, simply set the following environment variable: `PREFECT_API_URL`

{kubernetes_watch-0.1.5 → kubernetes_watch-0.1.9}/kube_watch/enums/kube.py

@@ -1,6 +1,6 @@
-from enum import Enum
-
-
-class Hosts(str, Enum):
-    LOCAL = 'local'
+from enum import Enum
+
+
+class Hosts(str, Enum):
+    LOCAL = 'local'
     REMOTE = 'remote'

{kubernetes_watch-0.1.5 → kubernetes_watch-0.1.9}/kube_watch/enums/logic.py

@@ -1,9 +1,9 @@
-from enum import Enum
-
-class Operations(str, Enum):
-    OR  = 'or'
-    AND = 'and'
-    SUM = 'sum'
-    AVG = 'avg'
-    MAX = 'max'
+from enum import Enum
+
+class Operations(str, Enum):
+    OR  = 'or'
+    AND = 'and'
+    SUM = 'sum'
+    AVG = 'avg'
+    MAX = 'max'
     MIN = 'min'

{kubernetes_watch-0.1.5 → kubernetes_watch-0.1.9}/kube_watch/enums/providers.py

@@ -1,13 +1,13 @@
-from enum import Enum
-
-class Providers(str, Enum):
-    AWS   = "aws"
-    AZURE = "azure"
-    GCP   = "gcp"
-    VAULT = "vault"
-
-
-class AwsResources(str, Enum):
-    ECR = "ecr" # elastic container registry
-    S3  = "s3"
+from enum import Enum
+
+class Providers(str, Enum):
+    AWS   = "aws"
+    AZURE = "azure"
+    GCP   = "gcp"
+    VAULT = "vault"
+
+
+class AwsResources(str, Enum):
+    ECR = "ecr" # elastic container registry
+    S3  = "s3"
     IAM = "iam" 

{kubernetes_watch-0.1.5 → kubernetes_watch-0.1.9}/kube_watch/enums/workflow.py

@@ -1,18 +1,18 @@
-from enum import Enum
-
-class ParameterType(str, Enum):
-    STATIC = 'static'
-    FROM_ENV = 'env'
-    FROM_FLOW = 'flow'
-
-
-class TaskRunners(str, Enum):
-    SEQUENTIAL = 'sequential'
-    CONCURRENT = 'concurrent'
-    DASK       = 'dask'
-    RAY        = 'ray'
-
-
-class TaskInputsType(str, Enum):
-    ARG = 'arg'
+from enum import Enum
+
+class ParameterType(str, Enum):
+    STATIC = 'static'
+    FROM_ENV = 'env'
+    FROM_FLOW = 'flow'
+
+
+class TaskRunners(str, Enum):
+    SEQUENTIAL = 'sequential'
+    CONCURRENT = 'concurrent'
+    DASK       = 'dask'
+    RAY        = 'ray'
+
+
+class TaskInputsType(str, Enum):
+    ARG = 'arg'
     DICT = 'dict'

{kubernetes_watch-0.1.5 → kubernetes_watch-0.1.9}/kube_watch/models/common.py

@@ -1,17 +1,17 @@
-from pydantic import BaseModel, ConfigDict
-from humps.camel import case
-
-def to_camel(string):
-    if string == "id":
-        return "_id"
-    if string.startswith("_"):  # "_id"
-        return string
-    return case(string)
-
-class CamelModel(BaseModel):
-    """
-    Replacement for pydanitc BaseModel which simply adds a camel case alias to every field
-    NOTE: This has been updated for Pydantic 2 to remove some common encoding helpers
-    """
-
+from pydantic import BaseModel, ConfigDict
+from humps.camel import case
+
+def to_camel(string):
+    if string == "id":
+        return "_id"
+    if string.startswith("_"):  # "_id"
+        return string
+    return case(string)
+
+class CamelModel(BaseModel):
+    """
+    Replacement for pydanitc BaseModel which simply adds a camel case alias to every field
+    NOTE: This has been updated for Pydantic 2 to remove some common encoding helpers
+    """
+
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)

{kubernetes_watch-0.1.5 → kubernetes_watch-0.1.9}/kube_watch/models/workflow.py

@@ -1,60 +1,60 @@
-from typing import List, Optional, Dict, Any
-from kube_watch.enums.workflow import ParameterType, TaskRunners, TaskInputsType
-from kube_watch.enums.logic import Operations
-
-from .common import CamelModel
-
-class Parameter(CamelModel):
-    name: str
-    value: Any
-    type: Optional[ParameterType] = ParameterType.STATIC
-
-class Artifact(CamelModel):
-    path: str
-
-class Inputs(CamelModel):
-    parameters: Optional[List[Parameter]] = []
-    artifacts: Optional[List[Artifact]] = []
-
-class Dependency(CamelModel):
-    taskName: str
-    inputParamName: Optional[str] = None
-
-class Condition(CamelModel):
-    tasks: List[str]
-    operation: Optional[Operations] = Operations.AND
-
-class Task(CamelModel):
-    """
-    :param plugin_path: define if referring to an external module outside the library.
-    """
-    module: str
-    task: str
-    name: str
-    plugin_path: Optional[str] = ""
-    inputsArgType: Optional[TaskInputsType] = TaskInputsType.ARG  # @TODO refactor inputsArgType to inputs_arg_type
-    inputs: Optional[Inputs] = None
-    dependency: Optional[List[Dependency]]  = None
-    conditional: Optional[Condition]  = None
-    outputs: Optional[List[str]]  = None
-
-class WorkflowConfig(CamelModel):
-    name: str
-    runner: TaskRunners = TaskRunners.CONCURRENT
-    parameters: Optional[List[Parameter]] = []
-    tasks: List[Task]
-
-class WorkflowOutput(CamelModel):
-    flow_run: Any
-    config: Any
-
-class BatchFlowItem(CamelModel):
-    path: str
-
-class BatchFlowConfig(CamelModel):
-    # Only possible runners are concurrent and sequential
-    runner: TaskRunners = TaskRunners.CONCURRENT
-    items: List[BatchFlowItem]
-
-
-
+from typing import List, Optional, Dict, Any
+from kube_watch.enums.workflow import ParameterType, TaskRunners, TaskInputsType
+from kube_watch.enums.logic import Operations
+
+from .common import CamelModel
+
+class Parameter(CamelModel):
+    name: str
+    value: Any
+    type: Optional[ParameterType] = ParameterType.STATIC
+
+class Artifact(CamelModel):
+    path: str
+
+class Inputs(CamelModel):
+    parameters: Optional[List[Parameter]] = []
+    artifacts: Optional[List[Artifact]] = []
+
+class Dependency(CamelModel):
+    taskName: str
+    inputParamName: Optional[str] = None
+
+class Condition(CamelModel):
+    tasks: List[str]
+    operation: Optional[Operations] = Operations.AND
+
+class Task(CamelModel):
+    """
+    :param plugin_path: define if referring to an external module outside the library.
+    """
+    module: str
+    task: str
+    name: str
+    plugin_path: Optional[str] = ""
+    inputsArgType: Optional[TaskInputsType] = TaskInputsType.ARG  # @TODO refactor inputsArgType to inputs_arg_type
+    inputs: Optional[Inputs] = None
+    dependency: Optional[List[Dependency]]  = None
+    conditional: Optional[Condition]  = None
+    outputs: Optional[List[str]]  = None
+
+class WorkflowConfig(CamelModel):
+    name: str
+    runner: TaskRunners = TaskRunners.CONCURRENT
+    parameters: Optional[List[Parameter]] = []
+    tasks: List[Task]
+
+class WorkflowOutput(CamelModel):
+    flow_run: Any
+    config: Any
+
+class BatchFlowItem(CamelModel):
+    path: str
+
+class BatchFlowConfig(CamelModel):
+    # Only possible runners are concurrent and sequential
+    runner: TaskRunners = TaskRunners.CONCURRENT
+    items: List[BatchFlowItem]
+
+
+