Expose json indent to the otio_json adapter (#641)

* Expose json indent to the otio_json adapter
* Added docs for otio_json adapter

Co-authored-by: Robyn Rindge <[email protected]>

Author: avrata

docs/tutorials/otio-plugins.md

@@ -116,15 +116,61 @@ This adapter lets you read and write native .otio files
 
 *Supported Features (with arguments)*:
 
-- read_from_file:
+- read_from_file: 
+```
+De-serializes an OpenTimelineIO object from a file
+
+  Args:
+      filepath (str): The path to an otio file to read from
+
+  Returns:
+      OpenTimeline: An OpenTimeline object
+```
   - filepath
-- read_from_string:
+- read_from_string: 
+```
+De-serializes an OpenTimelineIO object from a json string
+
+  Args:
+      input_str (str): A string containing json serialized otio contents
+
+  Returns:
+      OpenTimeline: An OpenTimeline object
+```
   - input_str
-- write_to_file:
+- write_to_file: 
+```
+Serializes an OpenTimelineIO object into a file
+
+  Args:
+      input_otio (OpenTimeline): An OpenTimeline object
+      filepath (str): The name of an otio file to write to
+      indent (int): number of spaces for each json indentation level. Use
+          -1 for no indentation or newlines.
+
+  Returns:
+      bool: Write success
+
+  Raises:
+      ValueError: on write error
+```
   - input_otio
   - filepath
-- write_to_string:
+  - indent
+- write_to_string: 
+```
+Serializes an OpenTimelineIO object into a string
+
+  Args:
+      input_otio (OpenTimeline): An OpenTimeline object
+      indent (int): number of spaces for each json indentation level. Use
+          -1 for no indentation or newlines.
+
+  Returns:
+      str: A json serialized string representation
+```
   - input_otio
+  - indent
 
 
 

src/py-opentimelineio/opentimelineio/adapters/otio_json.py

@@ -33,16 +33,60 @@
 
 
 def read_from_file(filepath):
+    """
+    De-serializes an OpenTimelineIO object from a file
+
+    Args:
+        filepath (str): The path to an otio file to read from
+
+    Returns:
+        OpenTimeline: An OpenTimeline object
+    """
     return core.deserialize_json_from_file(filepath)
 
 
 def read_from_string(input_str):
+    """
+    De-serializes an OpenTimelineIO object from a json string
+
+    Args:
+        input_str (str): A string containing json serialized otio contents
+
+    Returns:
+        OpenTimeline: An OpenTimeline object
+    """
     return core.deserialize_json_from_string(input_str)
 
 
-def write_to_string(input_otio):
-    return core.serialize_json_to_string(input_otio)
+def write_to_string(input_otio, indent=4):
+    """
+    Serializes an OpenTimelineIO object into a string
+
+    Args:
+        input_otio (OpenTimeline): An OpenTimeline object
+        indent (int): number of spaces for each json indentation level. Use
+            -1 for no indentation or newlines.
+
+    Returns:
+        str: A json serialized string representation
+    """
+    return core.serialize_json_to_string(input_otio, indent)
+
+
+def write_to_file(input_otio, filepath, indent=4):
+    """
+    Serializes an OpenTimelineIO object into a file
+
+    Args:
+        input_otio (OpenTimeline): An OpenTimeline object
+        filepath (str): The name of an otio file to write to
+        indent (int): number of spaces for each json indentation level. Use
+            -1 for no indentation or newlines.
 
+    Returns:
+        bool: Write success
 
-def write_to_file(input_otio, filepath):
-    return core.serialize_json_to_file(input_otio, filepath)
+    Raises:
+        ValueError: on write error
+    """
+    return core.serialize_json_to_file(input_otio, filepath, indent)