# 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** Compute Source Templates, Compute Requirement Templates, Keyrings, Credentials, Storage Configurations, Image Families, Allowances, Configured Worker Pools, User Attributes, Namespace Policies, Groups, and Applications 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
- **Finishing** Work Requirements with the **`yd-finish`** 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/3b/58/31f17639650075db51cadc2befb01c39c37d307cf932352825518ad93899/yellowdog_python_examples-8.1.1.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** Compute Source Templates, Compute Requirement Templates, Keyrings, Credentials, Storage Configurations, Image Families, Allowances, Configured Worker Pools, User Attributes, Namespace Policies, Groups, and Applications 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- **Finishing** Work Requirements with the **`yd-finish`** 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": "8.1.1",
"project_urls": {
"Homepage": "https://github.com/yellowdog/python-examples"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "52e8a5ce7f4c4a34577809bfb5af970af752897ff059d941b94d161278fdc88c",
"md5": "a157bd07fae892c2998335f1d5675d1d",
"sha256": "57f3d5f62f56fc8774b5f105ec1758dd129eaa086c88e3decd5c03e934000bd4"
},
"downloads": -1,
"filename": "yellowdog_python_examples-8.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a157bd07fae892c2998335f1d5675d1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 164990,
"upload_time": "2025-10-24T12:23:34",
"upload_time_iso_8601": "2025-10-24T12:23:34.627329Z",
"url": "https://files.pythonhosted.org/packages/52/e8/a5ce7f4c4a34577809bfb5af970af752897ff059d941b94d161278fdc88c/yellowdog_python_examples-8.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3b5831f17639650075db51cadc2befb01c39c37d307cf932352825518ad93899",
"md5": "b4756aa461878ff00e8151a165406612",
"sha256": "6efcd02909b30db035f6c931778a86b5e684b1fff0c29f7b94987cfdb4a91696"
},
"downloads": -1,
"filename": "yellowdog_python_examples-8.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b4756aa461878ff00e8151a165406612",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 185611,
"upload_time": "2025-10-24T12:23:36",
"upload_time_iso_8601": "2025-10-24T12:23:36.800634Z",
"url": "https://files.pythonhosted.org/packages/3b/58/31f17639650075db51cadc2befb01c39c37d307cf932352825518ad93899/yellowdog_python_examples-8.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 12:23:36",
"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": [
[
">=",
"11.3.0"
]
]
}
],
"lcname": "yellowdog-python-examples"
}
JSON
