diff --git a/docs/cookbook/usage_tips.rst b/docs/cookbook/usage_tips.rst index 620a9642..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 Flow Production Tracking API. 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 diff --git a/docs/index.rst b/docs/index.rst index 5eef5a61..c3ed66ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,21 +1,21 @@ -#################################### -Flow Production Tracking Python API3 -#################################### +########################################### +Flow Production Tracking Python API library +########################################### Release |version|. (:ref:`Installation `) .. image:: https://img.shields.io/badge/shotgun-api-blue.svg -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. +of the of the FPTR API3. .. _pythonoverviewvideo: