From 26f28bb505911640c021ebc8e39f30768754ed8f Mon Sep 17 00:00:00 2001 From: Eduardo Chauca Date: Fri, 26 Apr 2024 12:26:16 -0500 Subject: [PATCH 1/6] documentation title changed from Flow Production Tracking Python API3 to Flow Production Tracking Python API --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 5eef5a61..d496e80c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ #################################### -Flow Production Tracking Python API3 +Flow Production Tracking Python API #################################### Release |version|. (:ref:`Installation `) From 88b203d75a32464b49b29fbc6590997f48e9dcf0 Mon Sep 17 00:00:00 2001 From: Eduardo Chauca Date: Fri, 26 Apr 2024 12:31:18 -0500 Subject: [PATCH 2/6] deleting # to be align with text --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index d496e80c..ab8187b4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ -#################################### +################################### Flow Production Tracking Python API -#################################### +################################### Release |version|. (:ref:`Installation `) .. image:: https://img.shields.io/badge/shotgun-api-blue.svg From 6b4a724ba79d848e3fec6bfb825d497b6013b302 Mon Sep 17 00:00:00 2001 From: Eduardo Chauca Date: Fri, 26 Apr 2024 16:37:25 -0500 Subject: [PATCH 3/6] library suffix added in tittle --- docs/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index ab8187b4..3a09776a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ -################################### -Flow Production Tracking Python API -################################### +########################################### +Flow Production Tracking Python API library +########################################### Release |version|. (:ref:`Installation `) .. image:: https://img.shields.io/badge/shotgun-api-blue.svg From 1295cfd56b69dc1fc6ad6746c3cc51de19d6dc61 Mon Sep 17 00:00:00 2001 From: Eduardo Chauca Date: Mon, 29 Apr 2024 10:35:31 -0500 Subject: [PATCH 4/6] Added a new note to inform that FPTR API 3 is also known as Python API --- docs/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 3a09776a..919361f3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,6 +17,9 @@ Because the needs of every studio can prove to be very different, we don't inclu decisions to you. The API is powerful enough you can write your own "smarts" in a wrapper on top of the Flow Production Tracking API. +.. note:: + It's very important to know that Python API is also known as Flow Production Tracking API 3 (FPTR API 3). + .. _pythonoverviewvideo: Overview Video of Setting Up Your Environment with the Python API From 1014e1350e847ea2610e4c9bc03a867fcb845546 Mon Sep 17 00:00:00 2001 From: Eduardo Chauca Date: Mon, 29 Apr 2024 17:11:19 -0500 Subject: [PATCH 5/6] corrections about text and aclaration about python API is ready --- docs/cookbook/usage_tips.rst | 2 +- docs/index.rst | 11 ++++------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/cookbook/usage_tips.rst b/docs/cookbook/usage_tips.rst index 620a9642..0d59ee64 100644 --- a/docs/cookbook/usage_tips.rst +++ b/docs/cookbook/usage_tips.rst @@ -2,7 +2,7 @@ API Usage Tips ############## -Below is a list of helpful tips when using the Flow Production Tracking API. We have tried to make the API very +Below is a list of helpful tips when using the FPTR API3. We have tried to make the API very simple to use with predictable results while remaining a powerful tool to integrate with your pipeline. However, there's always a couple of things that crop up that our users might not be aware of. Those are the types of things you'll find below. We'll be adding to this document over diff --git a/docs/index.rst b/docs/index.rst index 919361f3..c3ed66ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,18 +7,15 @@ Release |version|. (:ref:`Installation `) -Flow Production Tracking provides a simple Python-based API for accessing Flow Production Tracking and integrating with other tools. -The Flow Production Tracking API allows users to integrate their tools with Flow Production Tracking very easily. Using this simple -but powerful python module , you can quickly get your scripts integrated with Flow Production Tracking's CRUD-based +Flow Production Tracking (FPTR) provides a simple Python-based API for accessing FPTR and integrating with other tools. +The Flow Production Tracking API3, also known as "Python API", allows users to integrate their tools with Flow Production Tracking very easily. Using this simple +but powerful python module, you can quickly get your scripts integrated with Flow Production Tracking's CRUD-based API. Because the needs of every studio can prove to be very different, we don't include a lot of "automation" or "smarts" in our API. We have kept it pretty low-level and leave most of those decisions to you. The API is powerful enough you can write your own "smarts" in a wrapper on top -of the Flow Production Tracking API. - -.. note:: - It's very important to know that Python API is also known as Flow Production Tracking API 3 (FPTR API 3). +of the of the FPTR API3. .. _pythonoverviewvideo: From b55656f04c56becc4d5009929880cef07cb9d38a Mon Sep 17 00:00:00 2001 From: Eduardo Chauca Date: Tue, 30 Apr 2024 07:26:01 -0500 Subject: [PATCH 6/6] correction about short version text --- docs/cookbook/usage_tips.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cookbook/usage_tips.rst b/docs/cookbook/usage_tips.rst index 0d59ee64..c2aa362b 100644 --- a/docs/cookbook/usage_tips.rst +++ b/docs/cookbook/usage_tips.rst @@ -2,7 +2,7 @@ API Usage Tips ############## -Below is a list of helpful tips when using the FPTR API3. We have tried to make the API very +Below is a list of helpful tips when using the Flow Production Tracking API3. We have tried to make the API very simple to use with predictable results while remaining a powerful tool to integrate with your pipeline. However, there's always a couple of things that crop up that our users might not be aware of. Those are the types of things you'll find below. We'll be adding to this document over