ctm-python-client 2.5.6__tar.gz → 2.5.8__tar.gz

ctm_python_client-2.5.8/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: ctm-python-client
+Version: 2.5.8
+Summary: Python Workflows for Control-M
+Author: BMC Software
+License: BSD 3-Clause
+Keywords: Control-M
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.23.0
+Requires-Dist: urllib3
+Requires-Dist: six
+Requires-Dist: attrs
+Requires-Dist: certifi
+Requires-Dist: jinja2
+Requires-Dist: cattrs>=24.1.3
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# Control-M Python Client
+
+Control-M Python Client is a python library to programmatically design, schedule and run your Control-M workflows. The design of the Control-M Python Client is oriented towards data scientists and developers who prefer a more programmatic approach to workflow orchestration.
+
+## Getting Started
+
+The best way to get familiar is to check the [Documentation](https://controlm.github.io/ctm-python-client/). Start with the [Tutorials](https://controlm.github.io/ctm-python-client/tutorials.html) to get familiar with the syntax.
+
+You do not need to have an in-depth knowledge of Control-M, but some familiarity with Control-M will help you understand the different job types and syntax offered by Control-M Python Client.
+
+## Installation
+
+Control-M Python client requires [Python](https://www.python.org/downloads/) version 3.10 or higher.
+
+We recommend to install Control-M Python Client in a [virtual environment](https://docs.python.org/3/library/venv.html).
+
+For Linux:
+```
+python -m venv venv
+source venv/bin/activate
+```
+
+For Windows:
+```
+python -m venv venv
+venv\Scripts\activate
+```
+
+### Installing via pip
+You will need pip and git installed on your system before you run this command.
+```
+pip install ctm-python-client
+```
+
+### Installing from source
+
+```
+git clone https://github.com/controlm/ctm-python-client.git
+pip install ctm-python-client
+```
+
+## Contributing and Support
+
+See [Contributing](https://github.com/controlm/ctm-python-client/blob/main/CONTRIBUTING.md)
+
+## Links
+
+- [Control-M Documentation](https://docs.bmc.com/docs/display/workloadautomation/Control-M+Workload+Automation+Documentation)
+- [Helix Control-M Documentation](https://documents.bmc.com/supportu/controlm-saas/en-US/Documentation/home.htm)
+- [Automation API Documentation](https://docs.bmc.com/docs/display/public/workloadautomation/Control-M+Automation+API+-+Getting+Started+Guide)
+- [Automation API with Helix Control-M Documentation](https://docs.bmc.com/docs/display/ctmSaaSAPI/Control-M+SaaS+Automation+API+Home)
+- [Provisioning an agent with Automation API](https://docs.bmc.com/docs/automation-api/monthly/provision-service-1040174602.html#Provisionservice-provisionFresh)
+- [Application Integrator](https://documents.bmc.com/supportu/9.0.20/etc/ai/help/en-US/Web_Help/index.htm#69319.htm)
+
+## License
+
+See [License](https://github.com/controlm/ctm-python-client/blob/main/LICENSE)

ctm_python_client-2.5.8/setup.py

@@ -0,0 +1,32 @@
+from setuptools import find_packages, setup
+from pathlib import Path
+
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
+setup(
+    name="ctm-python-client",
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    version="2.5.8",
+    description="Python Workflows for Control-M",
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    author="BMC Software",
+    license="BSD 3-Clause",
+    keywords="Control-M",
+    install_requires=[
+        "requests>=2.23.0",
+        "urllib3",
+        "six",
+        "attrs",
+        "certifi",
+        "jinja2",
+        "cattrs>=24.1.3"
+    ],
+    classifiers= [
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python :: 3"
+    ]
+)

ctm_python_client-2.5.8/src/aapi/bases.py

@@ -0,0 +1,144 @@
+import enum
+import json
+import random
+import typing
+
+import attrs
+
+from ctm_python_client.core.comm import Environment
+from ctm_python_client.core.monitoring import RunMonitor
+
+
+class AAPIJob:
+    pass
+
+
+class AAPIObject:
+    def as_aapi_dict(self, ignore_event_type=True):
+        
+        # Import inside the method to prevent circular import issues
+        from aapi.ifbase import IfCompletionStatus  
+        
+        res = {}
+
+        if '_type' in attrs.fields_dict(self.__class__):
+            is_condition_or_event = self._type.startswith(('Condition', 'Event'))
+    
+            if ignore_event_type:
+                if not is_condition_or_event:
+                    res['Type'] = self._type
+            elif self._type.startswith('Event'):
+                res['Type'] = self._type
+
+                
+        if attrs.has(self):
+            for field in attrs.fields(self.__class__):
+                value = self.__getattribute__(field.name)
+                ## API serialization hook
+                if "_aapi_serialize" in field.metadata:
+                    value = field.metadata["_aapi_serialize"](value)
+
+                aapi_repr = field.metadata.get("_aapi_repr_")
+
+                if value in [None, [], {}]:
+                    continue
+
+                if aapi_repr:
+                    if "_type_aapi_" in field.metadata:
+                        if "_hide_type_" in field.metadata:
+                            if "Type" in res:
+                                res.__delitem__("Type")
+                        continue
+                    if "as_aapi_dict" in dir(value):
+                        res[aapi_repr] = value.as_aapi_dict()
+                    elif isinstance(value, list):
+                        res[aapi_repr] = [
+                            (o.as_aapi_dict() if "as_aapi_dict" in dir(o) else o)
+                            for o in value
+                        ]
+                    elif isinstance(value, enum.Enum):
+                        res[aapi_repr] = value.value
+                    else:
+                        res[aapi_repr] = value
+
+                elif field.metadata.get("_abstract_aapi_container_"):
+                    for obj in value:
+                        obj_ignore_type = ignore_event_type
+                        if isinstance(self, IfCompletionStatus):
+                            obj_ignore_type = False  
+                        res[obj.object_name] = obj.as_aapi_dict(ignore_event_type=obj_ignore_type)
+
+        else:
+            res["attrsibutes_valid"] = False
+
+        return res
+
+    def dumps_aapi(self, indent=None):
+        return json.dumps(self.as_aapi_dict(), indent=indent)
+
+    def dump_aapi(self, f, indent=None):
+        return json.dump(self.as_aapi_dict(), f, indent=indent)
+
+    def as_dict(self):
+        return attrs.asdict(self)
+
+    def run_on_demand(
+        self,
+        environment: Environment,
+        skip_initial_authentication: bool = False,
+        inpath: str = f"run_on_demand{random.randint(100,999)}",
+        controlm_server: str = None,
+        run_as: str = None,
+        host: str = None,
+        application: str = None,
+        sub_application: str = None,
+        skip_login: bool = False,
+        file_path: str = None,
+        delete_afterwards: bool = True,
+        open_in_browser: str = None,
+    ) -> RunMonitor:
+        # Import circular dependency
+        from aapi import Folder
+        from ctm_python_client.core.workflow import Workflow, WorkflowDefaults
+
+        if (hasattr(self, "_type") and "Job" in self._type) or (
+            hasattr(self, "job_list")
+            and self.job_list is not None
+            and len(self.job_list) > 0
+        ):
+            try:
+                on_demand_workflow = Workflow(
+                    environment,
+                    WorkflowDefaults(
+                        controlm_server=controlm_server,
+                        run_as=run_as,
+                        host=host,
+                        application=application,
+                        sub_application=sub_application,
+                    ),
+                    skip_initial_authentication=skip_initial_authentication,
+                )
+                if isinstance(self, Folder):
+                    on_demand_workflow.add(self)
+                else:
+                    on_demand_workflow.add(self, inpath=inpath)
+
+                return on_demand_workflow.run_on_demand(
+                    skip_login=skip_login,
+                    file_path=file_path,
+                    delete_afterwards=delete_afterwards,
+                    open_in_browser=open_in_browser,
+                )
+            except Exception as e:
+                if hasattr(e, "body"):
+                    errors = [
+                        err.get("message", "") + " " + err.get("item", "")
+                        for err in json.loads(e.body)["errors"]
+                    ]
+                    raise RuntimeError(f"AAPI request failed: {', '.join(errors)}")
+                else:
+                    raise e
+            finally:
+                on_demand_workflow.clear_all()
+        else:
+            raise Exception("Run is not allowed for json without jobs")