shotgun-api3 3.9.1__py2.py3-none-any.whl → 3.9.2__py2.py3-none-any.whl

shotgun_api3/shotgun.py

@@ -94,7 +94,7 @@ SHOTGUN_API_DISABLE_ENTITY_OPTIMIZATION = False
 
 # ----------------------------------------------------------------------------
 # Version
-__version__ = "3.9.1"
+__version__ = "3.9.2"
 
 
 # ----------------------------------------------------------------------------
@@ -1882,6 +1882,29 @@ class Shotgun(object):
 
         return self._call_rpc("work_schedule_update", params)
 
+    def export_page(self, page_id, format, layout_name=None):
+        """
+        Export the specified page to the given format.
+        This method allows you to export a page to CSV.
+        Respective layout or page should be marked as API Exportable in the Flow Production Tracking UI.
+        For more information, see documentation_.
+        .. _documentation: https://help.autodesk.com/view/SGSUB/ENU/?guid=SG_Tutorials_tu_export_csv_html#enable-api-export-for-a-page
+        If ``layout_name`` is not passed in, the default layout name will be used.
+            >>> sg.export_page(12345, "csv", layout_name="My Layout")
+            "ID,Name,Status\\n1,Shot 001,ip\\n2,    Shot 002,rev\\n"
+            >>> sg.export_page(12345, "csv")
+            "ID,Name,Status\\n1,Shot 001,ip\\n2,Shot 002,rev\\n"
+        :param int page_id: The ID of the page to export.
+        :param str format: The format to export the page to. Supported format is ``"csv"``.
+        :param str layout_name: Optional layout name. This should be the name of the layout seen in the Flow Production Tracking UI.
+        :returns: string containing data of the given page.
+        :rtype: string
+        """
+
+        params = dict(format=format, page_id=page_id, layout_name=layout_name)
+
+        return self._call_rpc("export_page", params)
+
     def follow(self, user: Dict[str, Any], entity: Dict[str, Any]) -> Dict[str, Any]:
         """
         Add the entity to the user's followed entities.

{shotgun_api3-3.9.1.dist-info → shotgun_api3-3.9.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shotgun_api3
-Version: 3.9.1
+Version: 3.9.2
 Summary: Flow Production Tracking Python API
 Home-page: https://github.com/shotgunsoftware/python-api
 Author: Autodesk

{shotgun_api3-3.9.1.dist-info → shotgun_api3-3.9.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 shotgun_api3/__init__.py,sha256=sjcZn-5eIiTW9XSRVWp_ziuV-7N1E_a-Um8_bWnN0Gk,2192
 shotgun_api3/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-shotgun_api3/shotgun.py,sha256=0PxfGfJwUwn8awiHh4hotj-TzaT4TQep3lLXnYlElLc,198673
+shotgun_api3/shotgun.py,sha256=JqQ6Cjd5S76MxNhJwLzWXzpVt1k0UG_7_cYCA1gaikc,199993
 shotgun_api3/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 shotgun_api3/lib/pyparsing.py,sha256=54nWYMQzZu_Hy9_6Lj8LQGqQLWl4I57o0g2By2eKV-4,273322
 shotgun_api3/lib/sgtimezone.py,sha256=wZsSXq1R2nhtezoWYS6gi_jyuNF2XnBAgfokG0maQdQ,3390
@@ -20,8 +20,8 @@ shotgun_api3/lib/mockgun/__init__.py,sha256=TxZ__PD9gcayodOWO0v4F1zBOU2a5w2tOlPZ
 shotgun_api3/lib/mockgun/errors.py,sha256=BoSgMFKZmknWEGP36fPIaLeUxFt8LaSWBh09So8uIIM,2067
 shotgun_api3/lib/mockgun/mockgun.py,sha256=cGrxPjoJXLHNPt9fhNc7bCiJ8Qz498uLQuka3qhG3Sc,38226
 shotgun_api3/lib/mockgun/schema.py,sha256=sLrgSJC2bNO_wit1f84Xo1IUPvCunP60SpCoxr7w9a4,4875
-shotgun_api3-3.9.1.dist-info/licenses/LICENSE,sha256=AJTAS7bkObMedmRc5f0ZgWlvoay7p9XkggUQ3odOEeg,2824
-shotgun_api3-3.9.1.dist-info/METADATA,sha256=Le5BKO7lOcSq-IbRqfVBxnl_wDixTu_Vob_1yWz1dv4,7367
-shotgun_api3-3.9.1.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
-shotgun_api3-3.9.1.dist-info/top_level.txt,sha256=ySbEY-UvGvCuZYnVDmKpoRC6ROHEuKMppqIjqHHe8T0,13
-shotgun_api3-3.9.1.dist-info/RECORD,,
+shotgun_api3-3.9.2.dist-info/licenses/LICENSE,sha256=AJTAS7bkObMedmRc5f0ZgWlvoay7p9XkggUQ3odOEeg,2824
+shotgun_api3-3.9.2.dist-info/METADATA,sha256=98p0kfmU1n9t5ncMbGUjlMLzh-HKk16xkjGmekb1JuY,7367
+shotgun_api3-3.9.2.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+shotgun_api3-3.9.2.dist-info/top_level.txt,sha256=ySbEY-UvGvCuZYnVDmKpoRC6ROHEuKMppqIjqHHe8T0,13
+shotgun_api3-3.9.2.dist-info/RECORD,,