Package: sdvi-rally
Rally Python SDKA collection of classes and functions for interacting with SDVI Rally APIs.Refer to documentation found in your Rally Silo.v1.1.1 -- released 2 January 2023FixesChangeasset.set_asset_deadlineto allow setting deadline to None to remove deadlinev1.1.0 -- released 5 December 2023FeatureLimitdate_afterargument inset_scheduled_supply_chainto 93 daysAdded new functionedit_asset_status_indicatorto allow setting the color or message of an asset status indicatorFixesUpgraded urllib3 to version 1.25.8v1.0.16 -- released 24 October 2023FixesFixed an issue that allowed incorrect types to be assigned toset_scheduled_supply_chainargumentsv1.0.15 -- released 12 September 2023FeaturesSupplyChainStepnow takes an optional list of file labels (wait_file_labels) that forces the supply chain to wait
until files resolve toavailablebefore executing.  Usersmustspecify how long to wait for file labels to
resolve by specifyingwait_file_untilSupplyChainStepnow takes an optional value (job_metadata) that is included in report datav1.0.14 -- released 29 August 2023FixesShortened connection timeout so that fail-over occurs more quicklyv1.0.13 -- released 15 August 2023FeaturesAdddelete_scheduled_supply_chainto the supplyChain submodule, allowing users to delete a scheduled supply chain for the
current assetLimitwait_untilargument ofSupplyChainSteps to 93 daysVarious documentation clarificationsFixesAdded sorting by creation date tojob.get_jobs_for_asset()in order to paginate correctlyFixed an issue on some systems in whichrequestscould not find the correctcacert.pemfilev1.0.12 -- released 20 June 2023Featuresstatefilter param added tojob.get_jobs_for_asset()Fixesattempting to return aSupplyChainSplitwith no split steps will throw a more helpful errorattempting to return an emptySupplyChainSequencewill throw a more helpful errorvarious documentation fixes and clarificationsv1.0.11 -- released 6 June 2023Featuresidattribute added toasset.get_asset()resume_steparg to supplyChain.SupplyChainSplit() is now optionalv1.0.10 -- released 23 May 2023FeaturesstatusRefreshAtattribute added to location property of RallyFile class.refreshmethod added to RallyFile class.v1.0.9 -- released 25 Apr 2023Featureswait_untilhas been added to SupplyChainStep. This tag controls future execution of jobs.v1.0.8 -- released 28 Mar 2023FeaturesChanged default subject forsendNotificationto be 'No Subject: Notification from Decision Engine'pacing_taghas been added to SupplyChainStep. This tag controls pacing of Export jobsv1.0.7 -- released 28 Feb 2023FeatureserrorJobUuidhas been added to the context. This key contains the uuid of the job that triggered this fail stepconcurrency_taghas been added to SupplyChainStep. This tag controls maximum concurrency of active SdviMover jobsv1.0.6 -- released 14 Feb 2023Featuresjobs.get_jobs_for_assetnow returnsowner, the user id assigned to a work order, as part of the returned dictjobs.get_jobs_for_assetnow returnscreator, the user that created the job, as part of the returned dictFixesjobs.get_jobs_for_assettheuserkey has been deprecated in favor ofcreator. This is a non-breaking change,
asuseris still available in the returnv1.0.5 -- released 25 Oct 2022FixesFixes no cacert found issuev1.0.4 -- released 27 Aug 2022Behavior Changesasset.get_asset_status_indicatorsno longer returns cleared indicators by default. A new keyword argument,include_cleared, has been added to optionally return all indicators.FixesImproved efficiency ofasset.clear_all_asset_status_indicatorsImproved documentation of supply chain stepretry_policyv1.0.3 -- released 13 Aug 2022FeaturespresetNamehas been added to the context. This key contains the name of the current presetwfRuleNamehas been added to the context. This key contains the name of the current ruleUsers can now update user metadata usingasset.update_user_metadata. See documentation for usagev1.0.2 -- released 30 Aug 2022FixesTitles used in some documentation have been altered in an effort to clarify documentationRallyFile.idfield is now guaranteed to be anintRallyFileinitializer will now raise an error for invalid identifiersfiles.remove_inventorynow correctly marks file inventory objects asdeletedFixed a bug that prevented common error responses from returning with text and status codev1.0.1 -- released 19 July 2022FixesFixed a bug insupplyChain.set_supply_chain_metadatawhen attempting to set metadata on a supply chain with no
asset. This action now returnsNotFounderror.Fixed a bug inasset.clear_asset_status_indicatorwhen attempting to use invalid indicator idsFixed a parsing bug infiles.delete_filefor in files found in subfoldersasset.get_assetnow supports names with commasFixed a bug insupplyChain.start_new_supply_chainthat ignoredprovider_filterFixed a bug inSupplyChainStepthat ignoredprovider_filter. This action now raises an error if the supplied tag
does not exist.v1.0.0 -- released 10 May 2022FeaturesRally Decision Engine and SDK is now out of Beta! 💥️ 🎉 ️🎊 ️🎉 ️💥️v0.2.0 -- released 01 Apr 2022FeaturesAltering 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 hadasset_nameremoved from
their kwargs:asset.add_asset_status_indicatorasset.clear_all_asset_status_indicatorssupplyChain.set_scheduled_workflowFixesFixed a bug insupplyChain.get_scheduled_supply_chainandsupplyChain.set_scheduled_supply_chainthat was
improperly converting datetimesFixed an issue withfiles.delete_filethat prevented deletion of files in Storage Location subdirectoriesVarious documentation fixesv0.1.9 -- released 18 Jan 2022FeaturesAdded optionalremove_dateargument tofiles.RallyFile.remove_location()method, allows the actual delete to
occur at a later dateAddedsharedDeleteAtattribute toRallyFile.locationsAdded optionaltimeoutargument tofiles.RallyFile.presigned_url(),files.read_file(),files.read_files()methodsAddrallyUrlto SDK contextv0.1.8 -- released 09 Nov 2021FeaturesThere is a new library available!SDVI Rally Token Authallows users to easily access the v2 API from Decision Engine presets. Refer to preset documentation on your silo for
usage.AddedclientResourceIdattribute to return ofjobs.get_jobs_for_asset, if presentAsset Status Indicator methodsget_asset_status_indicators,add_asset_status_indicator,clear_asset_status_indicator, andclear_all_asset_status_indicatorsare being promoted out of Alpha.They will move out of theexperimentalsubmodule and into theassetsubmodule.
Import statements will change accordingly.FixesPresets can now correctly import zip packages placed in nested directories specified in
RallyConfigEval2Packagev0.1.7 -- released 12 Oct 2021FeaturesA 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:fromrallyimport__version__print(__version__)ORimportrallyprint(rally.__version__)Either results in "0.1.7". Note that this feature is not available in prior versions of the SDK.FixesSupplyChainStepfail_stepargument type was incorrectly listed as being either a string or a SupplyChainStep.fail_stepcould only be the stringnameof an alternate SupplyChainStep.fail_stepargument changed to string-typefail_step_namev0.1.6 -- released 29 Sept 2021FeaturesAdd support forforced_deletemode tofiles.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 forforced_deletemode tofiles.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.Fixesv0.1.5 -- released 31 Aug 2021FeaturesAddset_scheduled_supply_chainto the supplyChain submodule, allowing users to schedule a supply chain for the
current assetAddget_scheduled_supply_chainto the supplyChain submodule, returning a dict representation of an arbitrary asset's
scheduled supply chainFixesFix an issue with the SDK improperly handling missing environment variablev0.1.4 -- released 03 Aug 2021FeaturesAddpresigned_urlmethod toRallyFile. This returns a presigned url for a file.Addasset_nameandcategoryarguments tojobs.get_jobs_for_assetmethod.AddinputFileLabelto dictionary returned byjobs.get_jobs_for_asset.Addfail_stepargument tosupplyChain.SupplyChainStepcreation to specify a step to execute if the next step fails.Addjobs.cancel_jobmethod to cancel a job given its UUID.supplyChain.set_supply_chain_metadatanow overwrites existing metadata with the new value.
This enables users to remove top-level keys.FixessupplyChain.SupplyChainSplit.add_splitparamasynchas been renamed torun_async.v0.1.3 -- released 20 Jul 2021FeaturesAddasset_nameargument tojobs.get_job_reportmethod. This allows users to retrieve QC or analyze data from
arbitrary assets using the supplied provider type and label.Fixesv0.1.2 -- released 22 June 2021FeaturesAddfiles.write_filesmethod that offers parallel writing of files given a dict of URLs and contentAddfiles.read_filesmethod that offers parallel reading of files given a sequence of URLsCaution should be used when reading multiple filesfiles.list_filesnow returns both files and (subdirectories) at the specified url.Add License-only deadline argumentstep_deadline_lic_onlytosupplyChain.SupplyChainStepSupplyChainSplitandSupplyChainCancelcan now take aSupplyChainSequenceFixesSupplyChainStepnow correctly recognizesprovider_filtervaluesv0.1.1 -- released 16 Mar 2021FeaturesInitial Beta offering.