sdvi-rally 1.5.2

Rally Python SDK

Rally Python SDK

A collection of classes and functions for interacting with SDVI Rally APIs.

Refer to documentation found in your Rally Silo.

v1.5.2 -- released 22 October 2024

Fixes

• created SupplyChainSteps no longer include submit_on_hold if it was never set

---

v1.5.1 -- released 8 October 2024

Fixes

• Support filtering jobs by Salvaged state in get_jobs_for_asset

---

v1.5.0 -- released 24 September 2024

Features

• SupplyChainStep now takes an optional boolean argument submit_on_hold that causes the job to be submitted in the Hold state rather than the Queued state

---

v1.4.0 -- released 30 July 2024

Fixes

• Upgraded requests to version 2.32.3

---

v1.3.1 -- released 16 July 2024

• Internal change to make sparse get asset calls to reduce data retrieved

---

v1.3.0 -- released 4 June 2024

Fixes

• Upgraded certifi to version 2023.7.22
• Upgraded chardet to version 5.2.0
• Upgraded idna to version 3.6
• Upgraded requests to version 2.31.0
• Upgraded urllib3 to version 1.26.18

---

v1.2.0 -- released 9 April 2024

Feature

• Add new direct flag to notification.send_notification to send notifications immediately instead of queueing

---

v1.1.1 -- released 2 January 2023

Fixes

• Change asset.set_asset_deadline to allow setting deadline to None to remove deadline

---

v1.1.0 -- released 5 December 2023

Feature

• Limit date_after argument in set_scheduled_supply_chain to 93 days
• Added new function edit_asset_status_indicator to allow setting the color or message of an asset status indicator

Fixes

• Upgraded urllib3 to version 1.25.8

---

v1.0.16 -- released 24 October 2023

Fixes

• Fixed an issue that allowed incorrect types to be assigned to set_scheduled_supply_chain arguments

---

v1.0.15 -- released 12 September 2023

Features

• SupplyChainStep now takes an optional list of file labels (wait_file_labels) that forces the supply chain to wait until files resolve to available before executing. Users must specify how long to wait for file labels to resolve by specifying wait_file_until
• SupplyChainStep now takes an optional value (job_metadata) that is included in report data

---

v1.0.14 -- released 29 August 2023

Fixes

• Shortened connection timeout so that fail-over occurs more quickly

---

v1.0.13 -- released 15 August 2023

Features

• Add delete_scheduled_supply_chain to the supplyChain submodule, allowing users to delete a scheduled supply chain for the current asset
• Limit wait_until argument of SupplyChainSteps to 93 days
• Various documentation clarifications

Fixes

• Added sorting by creation date to job.get_jobs_for_asset() in order to paginate correctly
• Fixed an issue on some systems in which requests could not find the correct cacert.pem file

---

v1.0.12 -- released 20 June 2023

Features

• state filter param added to job.get_jobs_for_asset()

Fixes

• attempting to return a SupplyChainSplit with no split steps will throw a more helpful error
• attempting to return an empty SupplyChainSequence will throw a more helpful error
• various documentation fixes and clarifications

---

v1.0.11 -- released 6 June 2023

Features

• id attribute added to asset.get_asset()
• resume_step arg to supplyChain.SupplyChainSplit() is now optional

---

v1.0.10 -- released 23 May 2023

Features

• statusRefreshAt attribute added to location property of RallyFile class.
• refresh method added to RallyFile class.

---

v1.0.9 -- released 25 Apr 2023

Features

• wait_until has been added to SupplyChainStep. This tag controls future execution of jobs.

---

v1.0.8 -- released 28 Mar 2023

Features

• Changed default subject for sendNotification to be 'No Subject: Notification from Decision Engine'
• pacing_tag has been added to SupplyChainStep. This tag controls pacing of Export jobs

---

v1.0.7 -- released 28 Feb 2023

Features

• errorJobUuid has been added to the context. This key contains the uuid of the job that triggered this fail step
• concurrency_tag has been added to SupplyChainStep. This tag controls maximum concurrency of active SdviMover jobs

---

v1.0.6 -- released 14 Feb 2023

Features

• jobs.get_jobs_for_asset now returns owner, the user id assigned to a work order, as part of the returned dict
• jobs.get_jobs_for_asset now returns creator, the user that created the job, as part of the returned dict

Fixes

• jobs.get_jobs_for_asset the user key has been deprecated in favor of creator. This is a non-breaking change, asuser is still available in the return

---

v1.0.5 -- released 25 Oct 2022

Fixes

• Fixes no cacert found issue

---

v1.0.4 -- released 27 Aug 2022

Behavior Changes

• asset.get_asset_status_indicators no longer returns cleared indicators by default. A new keyword argument, include_cleared, has been added to optionally return all indicators.

Fixes

• Improved efficiency of asset.clear_all_asset_status_indicators
• Improved documentation of supply chain step retry_policy

---

v1.0.3 -- released 13 Aug 2022

Features

• presetName has been added to the context. This key contains the name of the current preset
• wfRuleName has been added to the context. This key contains the name of the current rule
• Users can now update user metadata using asset.update_user_metadata. See documentation for usage

---

v1.0.2 -- released 30 Aug 2022

Fixes

• Titles used in some documentation have been altered in an effort to clarify documentation
• RallyFile.id field is now guaranteed to be an int
• RallyFile initializer will now raise an error for invalid identifiers
• files.remove_inventory now correctly marks file inventory objects as deleted
• Fixed a bug that prevented common error responses from returning with text and status code

---

v1.0.1 -- released 19 July 2022

Fixes

• Fixed a bug in supplyChain.set_supply_chain_metadata when attempting to set metadata on a supply chain with no asset. This action now returns NotFound error.
• Fixed a bug in asset.clear_asset_status_indicator when attempting to use invalid indicator ids
• Fixed a parsing bug in files.delete_file for in files found in subfolders
• asset.get_asset now supports names with commas
• Fixed a bug in supplyChain.start_new_supply_chain that ignored provider_filter
• Fixed a bug in SupplyChainStep that ignored provider_filter. This action now raises an error if the supplied tag does not exist.

---

v1.0.0 -- released 10 May 2022

Features

• Rally Decision Engine and SDK is now out of Beta! 💥️ 🎉 ️🎊 ️🎉 ️💥️

---

v0.2.0 -- released 01 Apr 2022

Features

• Altering a different asset is no longer allowed in Decision Engine jobs. Allowing the alteration of another asset could cause unpredictable behavior as multiple jobs operated on the same asset at the same time. The best practice for altering any asset is to launch a supply chain with that asset. The following methods have had asset_name removed from their kwargs:
  • asset.add_asset_status_indicator
  • asset.clear_all_asset_status_indicators
  • supplyChain.set_scheduled_workflow

Fixes

• Fixed a bug in supplyChain.get_scheduled_supply_chain and supplyChain.set_scheduled_supply_chain that was improperly converting datetimes
• Fixed an issue with files.delete_file that prevented deletion of files in Storage Location subdirectories
• Various documentation fixes

---

v0.1.9 -- released 18 Jan 2022

Features

• Added optional remove_date argument to files.RallyFile.remove_location() method, allows the actual delete to occur at a later date
• Added sharedDeleteAt attribute to RallyFile.locations
• Added optional timeout argument to files.RallyFile.presigned_url(), files.read_file(), files.read_files() methods
• Add rallyUrl to SDK context

---

v0.1.8 -- released 09 Nov 2021

Features

• There is a new library available! SDVI Rally Token Auth allows users to easily access the v2 API from Decision Engine presets. Refer to preset documentation on your silo for usage.

• Added clientResourceId attribute to return of jobs.get_jobs_for_asset, if present

• Asset Status Indicator methods get_asset_status_indicators, add_asset_status_indicator, clear_asset_status_indicator, and clear_all_asset_status_indicators are being promoted out of Alpha. They will move out of the experimental submodule and into the asset submodule. Import statements will change accordingly.

Fixes

• Presets can now correctly import zip packages placed in nested directories specified in RallyConfig Eval2Package

---

v0.1.7 -- released 12 Oct 2021

Features

• A new key, rallyUrl, has been added to the context. This is the base URL for your silo's API.
• You can now find out the SDK version your silo is running:

  from rally import __version__
  
  print(__version__)
  

  OR

  import rally
  
  print(rally.__version__)
  

  Either results in "0.1.7". Note that this feature is not available in prior versions of the SDK.

Fixes

• SupplyChainStep fail_step argument type was incorrectly listed as being either a string or a SupplyChainStep. fail_step could only be the string name of an alternate SupplyChainStep. fail_step argument changed to string-type fail_step_name

---

v0.1.6 -- released 29 Sept 2021

Features

• Add support for forced_delete mode to files.RallyFile.remove_location() method. This option removes a file location from the asset's inventory and deletes the file even if it is referenced by another asset.
• Add support for forced_delete mode to files.remove_inventory() method. This option removes a file reference from the asset's inventory and deletes the file locations even if they are referenced by another asset.

Fixes

---

v0.1.5 -- released 31 Aug 2021

Features

• Add set_scheduled_supply_chain to the supplyChain submodule, allowing users to schedule a supply chain for the current asset
• Add get_scheduled_supply_chain to the supplyChain submodule, returning a dict representation of an arbitrary asset's scheduled supply chain

Fixes

• Fix an issue with the SDK improperly handling missing environment variable

---

v0.1.4 -- released 03 Aug 2021

Features

• Add presigned_url method to RallyFile. This returns a presigned url for a file.
• Add asset_name and category arguments to jobs.get_jobs_for_asset method.
• Add inputFileLabel to dictionary returned by jobs.get_jobs_for_asset.
• Add fail_step argument to supplyChain.SupplyChainStep creation to specify a step to execute if the next step fails.
• Add jobs.cancel_job method to cancel a job given its UUID.
• supplyChain.set_supply_chain_metadata now overwrites existing metadata with the new value. This enables users to remove top-level keys.

Fixes

• supplyChain.SupplyChainSplit.add_split param async has been renamed to run_async.

---

v0.1.3 -- released 20 Jul 2021

Features

• Add asset_name argument to jobs.get_job_report method. This allows users to retrieve QC or analyze data from arbitrary assets using the supplied provider type and label.

Fixes

---

v0.1.2 -- released 22 June 2021

Features

• Add files.write_files method that offers parallel writing of files given a dict of URLs and content
• Add files.read_files method that offers parallel reading of files given a sequence of URLs Caution should be used when reading multiple files
• files.list_files now returns both files and (subdirectories) at the specified url.
• Add License-only deadline argument step_deadline_lic_only to supplyChain.SupplyChainStep
• SupplyChainSplit and SupplyChainCancel can now take a SupplyChainSequence

Fixes

• SupplyChainStep now correctly recognizes provider_filter values

---

v0.1.1 -- released 16 Mar 2021

Features

• Initial Beta offering.