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. Start with the Tutorials 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 version 3.7 or higher.

We recommend to install Control-M Python Client in a virtual environment.

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

Links

• Control-M Documentation
• Helix Control-M Documentation
• Automation API Documentation
• Automation API with Helix Control-M Documentation
• Provisioning an agent with Automation API
• Application Integrator

License

See License