# 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)
Raw data
{
"_id": null,
"home_page": null,
"name": "ctm-python-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Control-M",
"author": "BMC Software",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1f/cf/176a5717b67ab74e7837a03ed4b905eba732e3c9a2fd8864163e13694fb4/ctm_python_client-2.5.4.tar.gz",
"platform": null,
"description": "# Control-M Python Client\n\nControl-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.\n\n## Getting Started\n\nThe 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.\n\nYou 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.\n\n## Installation\n\nControl-M Python client requires [Python](https://www.python.org/downloads/) version 3.10 or higher.\n\nWe recommend to install Control-M Python Client in a [virtual environment](https://docs.python.org/3/library/venv.html).\n\nFor Linux:\n```\npython -m venv venv\nsource venv/bin/activate\n```\n\nFor Windows:\n```\npython -m venv venv\nvenv\\Scripts\\activate\n```\n\n### Installing via pip\nYou will need pip and git installed on your system before you run this command.\n```\npip install ctm-python-client\n```\n\n### Installing from source\n\n```\ngit clone https://github.com/controlm/ctm-python-client.git\npip install ctm-python-client\n```\n\n## Contributing and Support\n\nSee [Contributing](https://github.com/controlm/ctm-python-client/blob/main/CONTRIBUTING.md)\n\n## Links\n\n- [Control-M Documentation](https://docs.bmc.com/docs/display/workloadautomation/Control-M+Workload+Automation+Documentation)\n- [Helix Control-M Documentation](https://documents.bmc.com/supportu/controlm-saas/en-US/Documentation/home.htm)\n- [Automation API Documentation](https://docs.bmc.com/docs/display/public/workloadautomation/Control-M+Automation+API+-+Getting+Started+Guide)\n- [Automation API with Helix Control-M Documentation](https://docs.bmc.com/docs/display/ctmSaaSAPI/Control-M+SaaS+Automation+API+Home)\n- [Provisioning an agent with Automation API](https://docs.bmc.com/docs/automation-api/monthly/provision-service-1040174602.html#Provisionservice-provisionFresh)\n- [Application Integrator](https://documents.bmc.com/supportu/9.0.20/etc/ai/help/en-US/Web_Help/index.htm#69319.htm)\n\n## License\n\nSee [License](https://github.com/controlm/ctm-python-client/blob/main/LICENSE)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "Python Workflows for Control-M",
"version": "2.5.4",
"project_urls": null,
"split_keywords": [
"control-m"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e60cacb6fbc5c346e54866d818d6a462248d266799182b979ea35cb2107de22e",
"md5": "2fbc77ff734e136848f03ea1cbaa79ff",
"sha256": "d1c15044d235779c646261b13fcb017fd55dcb095001d82afc2b97d7ff59c99a"
},
"downloads": -1,
"filename": "ctm_python_client-2.5.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fbc77ff734e136848f03ea1cbaa79ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1242775,
"upload_time": "2025-08-18T11:49:10",
"upload_time_iso_8601": "2025-08-18T11:49:10.285738Z",
"url": "https://files.pythonhosted.org/packages/e6/0c/acb6fbc5c346e54866d818d6a462248d266799182b979ea35cb2107de22e/ctm_python_client-2.5.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1fcf176a5717b67ab74e7837a03ed4b905eba732e3c9a2fd8864163e13694fb4",
"md5": "0220ce79058056d8dcd02e23a86f8cc1",
"sha256": "0b844b5b61bc195ed323d119dbc7c7a2e7ae3b6908a092e71591c37e26bd4f20"
},
"downloads": -1,
"filename": "ctm_python_client-2.5.4.tar.gz",
"has_sig": false,
"md5_digest": "0220ce79058056d8dcd02e23a86f8cc1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 472808,
"upload_time": "2025-08-18T11:49:12",
"upload_time_iso_8601": "2025-08-18T11:49:12.084855Z",
"url": "https://files.pythonhosted.org/packages/1f/cf/176a5717b67ab74e7837a03ed4b905eba732e3c9a2fd8864163e13694fb4/ctm_python_client-2.5.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-18 11:49:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ctm-python-client"
}
JSON