# Example Python CLI commands using the YellowDog Python SDK
## Overview
This is a set of Python CLI commands for interacting with the YellowDog Platform, providing examples of usage of the [YellowDog Python SDK](https://docs.yellowdog.co/api/python/index.html).
The commands support:
- **Aborting** running Tasks with the **`yd-abort`** command
- **Boosting** Allowances with the **`yd-boost`** command
- **Cancelling** Work Requirements with the **`yd-cancel`** command
- **Comparing** whether worker pools are a match for task groups with the **`yd-compare`** command
- **Creating, Updating and Removing** Source Templates, Compute Templates, Keyrings, Credentials, Namespace Storage Configurations, Image Families, Allowances, Configured Worker Pools, User Attributes, and Namespace Policies with the **`yd-create`** and **`yd-remove`** commands
- **Deleting** objects in the YellowDog Object Store with the **`yd-delete`** command
- **Downloading** Results from the YellowDog Object Store with the **`yd-download`** command
- **Following Event Streams** for Work Requirements, Worker Pools and Compute Requirements with the **`yd-follow`** command
- **Instantiating** Compute Requirements with the **`yd-instantiate`** command
- **Listing** YellowDog items using the **`yd-list`** command
- **Provisioning** Worker Pools with the **`yd-provision`** command
- **Resizing** Worker Pools and Compute Requirements with the **`yd-resize`** command
- **Showing** the details of any YellowDog entity using its YellowDog ID with the **`yd-show`** command
- **Shutting Down** Worker Pools and Nodes with the **`yd-shutdown`** command
- **Starting** HELD Work Requirements and **Holding** (or pausing) RUNNING Work Requirements with the **`yd-start`** and **`yd-hold`** commands
- **Submitting** Work Requirements with the **`yd-submit`** command
- **Terminating** Compute Requirements with the **`yd-terminate`** command
- **Uploading** files to the YellowDog Object Store with the **`yd-upload`** command
Please see the documenation in the [GitHub repository](https://github.com/yellowdog/python-examples) for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "yellowdog-python-examples",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "YellowDog Limited <support@yellowdog.co>",
"download_url": "https://files.pythonhosted.org/packages/13/54/442f23532707f7c33d52263aea6ef71195460b5140a2bfc31df714bd0081/yellowdog_python_examples-7.19.7.tar.gz",
"platform": null,
"description": "# Example Python CLI commands using the YellowDog Python SDK\n\n## Overview\n\nThis is a set of Python CLI commands for interacting with the YellowDog Platform, providing examples of usage of the [YellowDog Python SDK](https://docs.yellowdog.co/api/python/index.html).\n\nThe commands support:\n\n- **Aborting** running Tasks with the **`yd-abort`** command\n- **Boosting** Allowances with the **`yd-boost`** command\n- **Cancelling** Work Requirements with the **`yd-cancel`** command\n- **Comparing** whether worker pools are a match for task groups with the **`yd-compare`** command\n- **Creating, Updating and Removing** Source Templates, Compute Templates, Keyrings, Credentials, Namespace Storage Configurations, Image Families, Allowances, Configured Worker Pools, User Attributes, and Namespace Policies with the **`yd-create`** and **`yd-remove`** commands\n- **Deleting** objects in the YellowDog Object Store with the **`yd-delete`** command\n- **Downloading** Results from the YellowDog Object Store with the **`yd-download`** command\n- **Following Event Streams** for Work Requirements, Worker Pools and Compute Requirements with the **`yd-follow`** command\n- **Instantiating** Compute Requirements with the **`yd-instantiate`** command\n- **Listing** YellowDog items using the **`yd-list`** command\n- **Provisioning** Worker Pools with the **`yd-provision`** command\n- **Resizing** Worker Pools and Compute Requirements with the **`yd-resize`** command\n- **Showing** the details of any YellowDog entity using its YellowDog ID with the **`yd-show`** command\n- **Shutting Down** Worker Pools and Nodes with the **`yd-shutdown`** command\n- **Starting** HELD Work Requirements and **Holding** (or pausing) RUNNING Work Requirements with the **`yd-start`** and **`yd-hold`** commands\n- **Submitting** Work Requirements with the **`yd-submit`** command\n- **Terminating** Compute Requirements with the **`yd-terminate`** command\n- **Uploading** files to the YellowDog Object Store with the **`yd-upload`** command\n\nPlease see the documenation in the [GitHub repository](https://github.com/yellowdog/python-examples) for more details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python CLI commands using the YellowDog Python SDK",
"version": "7.19.7",
"project_urls": {
"Homepage": "https://github.com/yellowdog/python-examples"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bf3132d9b79150dca0fcf80a022cd4be7b031af39216f1970676699ebbdfc7c5",
"md5": "b393e29b17c05d739378644a2589b374",
"sha256": "adf7f63990a0f400904ca91c88df2bc1bd09b9d436764d519953fb08fbde0ca0"
},
"downloads": -1,
"filename": "yellowdog_python_examples-7.19.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b393e29b17c05d739378644a2589b374",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 161152,
"upload_time": "2025-09-10T14:50:06",
"upload_time_iso_8601": "2025-09-10T14:50:06.500058Z",
"url": "https://files.pythonhosted.org/packages/bf/31/32d9b79150dca0fcf80a022cd4be7b031af39216f1970676699ebbdfc7c5/yellowdog_python_examples-7.19.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1354442f23532707f7c33d52263aea6ef71195460b5140a2bfc31df714bd0081",
"md5": "ac74b733d9b364d6c8d535c314d8f7c7",
"sha256": "286ca12a21ce19a94842067f74c2dc778d04680c9c601e93b6bbed1682c24fb9"
},
"downloads": -1,
"filename": "yellowdog_python_examples-7.19.7.tar.gz",
"has_sig": false,
"md5_digest": "ac74b733d9b364d6c8d535c314d8f7c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 181882,
"upload_time": "2025-09-10T14:50:07",
"upload_time_iso_8601": "2025-09-10T14:50:07.964382Z",
"url": "https://files.pythonhosted.org/packages/13/54/442f23532707f7c33d52263aea6ef71195460b5140a2bfc31df714bd0081/yellowdog_python_examples-7.19.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-10 14:50:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yellowdog",
"github_project": "python-examples",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "PyPAC",
"specs": [
[
">=",
"0.16.4"
]
]
},
{
"name": "dateparser",
"specs": []
},
{
"name": "python-dotenv",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "rich",
"specs": [
[
"==",
"13.9.4"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.9.0"
]
]
},
{
"name": "toml",
"specs": []
},
{
"name": "yellowdog-sdk",
"specs": [
[
">=",
"10.0.0"
]
]
}
],
"lcname": "yellowdog-python-examples"
}
JSON
