Run & Folder Filtering and Starring

[kzscisoft]

Add Filter Interface to Run and Folder Low Level API and Starring

Issue: N/A

Python Version(s) Tested: 3.13.5

Operating System(s): Ubuntu 25.10

Documentation PR: Issue on Docs repo.

📝 Summary

• Adds a user-friendly interface in the LLAPI for applying filters during Run and Folder retrieval.
• Adds missing ability to star folders and runs.

🔄 Changes

Starring

You can now star folders and runs using the low level API, note starring is only possible after an object has already been created:

from simvue.api.objects import Run, Folder

_folder = Folder.new(path="/my_test_folder")
_folder.commit()
_folder.star = True
_folder.commit()

_run = Run.new(folder="/my_test_folder")
_run.commit()
_run.star = True
_run.commit()

Filtering Runs and Folders

There is now a new submodule simvue.api.objects.filters which handles assembly and creation of filter strings.

_run_search = Run.filter().has_tag("my_tag").starred().has_name_containing("my")
print(_run_search.count())

for id, run in _run_search.get():
   ...

✔️ Checklist

• Unit and integration tests passing.
• Pre-commit hooks passing.
• Quality checks passing.
• Updated the documentation.