Metadata-Version: 2.2
Name: yellowdog-python-examples
Version: 7.15.5
Summary: Python CLI commands using the YellowDog Python SDK
Author-email: YellowDog Limited <support@yellowdog.co>
Project-URL: Homepage, https://github.com/yellowdog/python-examples
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: yellowdog-sdk>=8.6.2
Requires-Dist: toml
Requires-Dist: tabulate>=0.9.0
Requires-Dist: PyPAC>=0.16.4
Requires-Dist: rich==13.9.4
Requires-Dist: requests
Requires-Dist: dateparser
Provides-Extra: jsonnet
Requires-Dist: jsonnet; extra == "jsonnet"
Provides-Extra: cloudwizard
Requires-Dist: boto3; extra == "cloudwizard"
Requires-Dist: google-cloud-compute; extra == "cloudwizard"
Requires-Dist: google-cloud-storage; extra == "cloudwizard"
Requires-Dist: azure-identity; extra == "cloudwizard"
Requires-Dist: azure-mgmt-resource; extra == "cloudwizard"
Requires-Dist: azure-mgmt-network; extra == "cloudwizard"
Requires-Dist: azure-mgmt-storage; extra == "cloudwizard"
Requires-Dist: azure-mgmt-subscription; extra == "cloudwizard"

# 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
- **Creating, Updating and Removing** Source Templates, Compute Templates, Keyrings, Credentials, Namespace Storage Configurations, Image Families, Allowances, Source Template Attribute definitions, and Configured Worker Pools 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** many types of YellowDog item using the **`yd-list`** command
- **Provisioning** Cloud 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 by its YellowDog ID with the **`yd-show`** command
- **Shutting Down** Worker Pools 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.
