feat: example to upload file to SystemLink

ni · Nov 7, 2024 · 6e849fd · 6e849fd
1 parent e1dc1c6
commit 6e849fd
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -182,5 +182,11 @@ Examples
 Get the metadata of a File using its Id and download it.
 
 .. literalinclude:: ../examples/file/download_file.py
+   :language: python
+   :linenos:
+
+Upload a File from disk to SystemLink
+
+.. literalinclude:: ../examples/file/upload_file.py
    :language: python
    :linenos:
diff --git a/examples/file/upload_file.py b/examples/file/upload_file.py
@@ -0,0 +1,12 @@
+"""Example to upload a file to SystemLink."""
+
+from nisystemlink.clients.file import FileClient
+
+client = FileClient()
+
+file_path = "path/to/your/file"
+workspace_id = None  # Upload to default workspace of the auth key
+
+with open(file_path, "rb") as fp:
+    file_id = client.upload_file(file=fp, workspace=workspace_id)
+    print(f"Uploaded file from {file_path} to SystemLink with FileID - {file_id}")