add script bfabric_save_resource_description.py

docs/changelog.md

@@ -17,6 +17,7 @@ instead a separate Python package with its individual changelog.
 
 - Relationship: `ExternalJob.executable`
 - (experimental) EntityLookupCache that allows to cache entity lookups in a script to avoid redundant requests.
+- Specific use case script: bfabric_save_resource_description.py (the functionality will be available in a future CLI).
 
 ### Fixed
 

pyproject.toml

@@ -76,6 +76,7 @@ Repository = "https://github.com/fgcz/bfabricPy"
 "bfabric_save_workunit_attribute.py" = "bfabric_scripts.bfabric_save_workunit_attribute:main"
 "bfabric_save_workflowstep.py" = "bfabric_scripts.bfabric_save_workflowstep:main"
 "bfabric_slurm_queue_status.py" = "bfabric_scripts.bfabric_slurm_queue_status:main"
+"bfabric_save_resource_description.py" = "bfabric_scripts.bfabric_save_resource_description:main"
 
 [tool.setuptools.package-data]
 "*" = ["py.typed"]

src/bfabric_scripts/bfabric_save_resource_description.py

@@ -0,0 +1,28 @@
+import argparse
+from pathlib import Path
+
+from rich.pretty import pprint
+
+from bfabric import Bfabric
+from bfabric.cli_formatting import setup_script_logging
+
+
+def save_resource_description(client: Bfabric, id: int, description_file: Path) -> None:
+    description = description_file.read_text()
+    obj = {"id": id, "description": description}
+    response = client.save(endpoint="resource", obj=obj)
+    pprint(response[0], indent_guides=False)
+
+
+def main() -> None:
+    setup_script_logging()
+    parser = argparse.ArgumentParser()
+    parser.add_argument("id", type=int)
+    parser.add_argument("description_file", type=Path)
+    client = Bfabric.from_config()
+    args = parser.parse_args()
+    save_resource_description(client=client, **vars(args))
+
+
+if __name__ == "__main__":
+    main()