SG-34087 - Rebranding

HISTORY.rst

@@ -1,6 +1,6 @@
-*****************************
-ShotGrid Python API Changelog
-*****************************
+*********************************************
+Flow Production Tracking Python API Changelog
+*********************************************
 
 Here you can see the full list of changes between each Python API release.
 
@@ -173,7 +173,7 @@ v3.0.32 (2016 Sep 22)
 
 - Optimized import speed of the API on Python 2.7.
 - Integrated the latest fixes to the ``mimetypes`` module.
-- Added ``nav_expand()`` method as an experimental, internal method for querying SG hierarchy. 
+- Added ``nav_expand()`` method as an experimental, internal method for querying SG hierarchy.
 - Ported all documentation to sphinx. See http://developer.shotgridsoftware.com/python-api.
 - Moved Changelog to dedicated HISTORY file.
 

README.md

@@ -4,9 +4,9 @@
 [![Build Status](https://dev.azure.com/shotgun-ecosystem/Python%20API/_apis/build/status/shotgunsoftware.python-api?branchName=master)](https://dev.azure.com/shotgun-ecosystem/Python%20API/_build/latest?definitionId=108&branchName=master)
 [![Coverage Status](https://coveralls.io/repos/github/shotgunsoftware/python-api/badge.svg?branch=master)](https://coveralls.io/github/shotgunsoftware/python-api?branch=master)
 
-# ShotGrid Python API
+# Flow Production Tracking Python API
 
-ShotGrid provides a simple Python-based API for accessing ShotGrid and integrating with other tools. This is the official API that is maintained by ShotGrid Software (https://knowledge.autodesk.com/contact-support)
+Autodesk provides a simple Python-based API for accessing Flow Production Tracking and integrating with other tools. This is the official API that is maintained by Autodesk (https://knowledge.autodesk.com/contact-support)
 
 The latest version can always be found at http://github.com/shotgunsoftware/python-api
 
@@ -48,8 +48,8 @@ Integration and unit tests are provided.
 - A `tests/config` file (you can copy an example from `tests/example_config`).
 - Tests can be run individually like this: `nosetests --config="nose.cfg" tests/test_client.py`
     - Make sure to not forget the `--config="nose.cfg"` option. This option tells nose to use our config file.  This will exclude python 2- and 3-specific files in the `/lib` directory, preventing a failure from being reported by nose for compilation due to incompatible syntax in those files.
-- `test_client` and `tests_unit` use mock server interaction and do not require a ShotGrid instance to be available (no modifications to `tests/config` are necessary).
-- `test_api` and `test_api_long` *do* require a ShotGrid instance, with a script key available for the tests. The server and script user values must be supplied in the `tests/config` file. The tests will add test data to your server based on information in your config. This data will be manipulated by the tests, and should not be used for other purposes.
+- `test_client` and `tests_unit` use mock server interaction and do not require a Flow Production Tracking instance to be available (no modifications to `tests/config` are necessary).
+- `test_api` and `test_api_long` *do* require a Flow Production Tracking instance, with a script key available for the tests. The server and script user values must be supplied in the `tests/config` file. The tests will add test data to your server based on information in your config. This data will be manipulated by the tests, and should not be used for other purposes.
 - To run all of the tests, use the shell script `run-tests`.
 
 ## Release process

SECURITY.md

@@ -4,18 +4,18 @@
 
 At Autodesk, we know that the security of your data is critical to your studio’s
 operation.
-As the industry shifts to the cloud, ShotGrid knows that security and service
+As the industry shifts to the cloud, Flow Production Tracking knows that security and service
 models are more important than ever.
 
 The confidentiality, integrity, and availability of your content is at the top
 of our priority list.
-Not only do we have a team of ShotGrid engineers dedicated to platform security
+Not only do we have a team of Flow Production Tracking engineers dedicated to platform security
 and performance, we are also backed by Autodesk’s security team, also invests
 heavily in the security for broad range of industries and customers.
 We constantly reassess, develop, and improve our risk management program because
 we know that the landscape of security is ever-changing.
 
-If you believe you have found a security vulnerability in any ShotGrid-owned
+If you believe you have found a security vulnerability in any Flow Production Tracking-owned
 repository, please report it to us as described below.
 
 
@@ -32,4 +32,4 @@ configurations, reproduction steps, exploit code, impact, etc.
 
 ## Additional Information
 
-Please check out the [ShotGrid Security White Paper](https://help.autodesk.com/view/SGSUB/ENU/?guid=SG_Administrator_ar_general_security_ar_security_white_paper_html).
+Please check out the [Flow Production Tracking Security White Paper](https://help.autodesk.com/view/SGSUB/ENU/?guid=SG_Administrator_ar_general_security_ar_security_white_paper_html).

azure-pipelines-templates/run-tests.yml

@@ -99,7 +99,7 @@ jobs:
       pytest -v --cov shotgun_api3 --cov-report xml --test-run-title="${{parameters.name}}-$(python.version)"
     displayName: Running tests
     env:
-      # Pass the values needed to authenticate with the Shotgun site and create some entities.
+      # Pass the values needed to authenticate with the Flow Production Tracking site and create some entities.
       # Remember, on a pull request from a client or on forked repos, those variables
       # will be empty!
       SG_SERVER_URL: $(ci_site)

docs/advanced/packaging.rst

@@ -14,8 +14,8 @@ There are caveats you need to be aware of when creating such an app.
 ********************************
 HTTPS Validation and cacerts.txt
 ********************************
-When creating the connection to ShotGrid a file is used to validate the ShotGrid certificate. This
-file is located at ``shotgun_api3/lib/httplib2/cacerts.txt``. Because this file is not a Python
+When creating the connection to Flow Production Tracking, a file is used to validate the Flow Production Tracking
+certificate. This file is located at ``shotgun_api3/lib/httplib2/cacerts.txt``. Because this file is not a Python
 file imported by your application, py2app will not know to include it in your package, it will
 need to be explicitly specified in your ``setup.py`` file (edit the path based on the location
 where your ``shotgun_api3`` package is located)::
@@ -31,7 +31,7 @@ following structure::
     ./Contents/Resources/my_script.py
 
 Where in ``my_script.py`` you can access the ``cacerts.txt`` file using a relative path to pass it
-into the ShotGrid connection's constructor::
+into the Flow Production Tracking connection's constructor::
 
     ca_certs = os.path.join(os.path.dirname(__file__), 'shotgun_api3', 'cacerts.txt')
     sg = shotgun_api3.Shotgun('https://my-site.shotgrid.autodesk.com', 'script_name', 'script_key',

docs/authentication.rst

@@ -2,7 +2,7 @@
 Authentication
 ##############
 
-In order to communicate with your ShotGrid server via the API, you must provide valid authentication credentials. The API allows you to authenticate with user-based, or script-based credentials.
+In order to communicate with your server via the API, you must provide valid authentication credentials. The API allows you to authenticate with user-based, or script-based credentials.
 
 *************************
 User-based Authentication
@@ -17,49 +17,49 @@ When authenticating as a user, you provide your normal login and password when i
 ***************************
 Script-based Authentication
 ***************************
-In order to authenticate as a script, your script must be :ref:`registered with ShotGrid and have a valid API key <setting_up_shotgrid>`. When creating your :class:`shotgun_api3.Shotgun` object, provide the ``script_name`` and ``api_key``.::
+In order to authenticate as a script, your script must be :ref:`registered with Flow Production Tracking and have a valid API key <setting_up_shotgrid>`. When creating your :class:`shotgun_api3.Shotgun` object, provide the ``script_name`` and ``api_key``.::
 
     sg = shotgun_api3.Shotgun("https://my-site.shotgrid.autodesk.com",
                               script_name="compress",
                               api_key="0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef")
 
-.. note:: When using script-based authentication, we **strongly** recommend you register each script separately with ShotGrid and have individual API keys for each. This allows you to track down each of your scripts and the actions they are performing much more accurately in the event logs.
+.. note:: When using script-based authentication, we **strongly** recommend you register each script separately with Flow Production Tracking and have individual API keys for each. This allows you to track down each of your scripts and the actions they are performing much more accurately in the event logs.
 
 
 .. _setting_up_shotgrid:
 
 Adding Script Users
 ===================
-If you'll be using script-based authentication, you need to create a Script entity in ShotGrid. To create a new key, click the + button on the "Scripts" page in the Admin section and give your script a useful name. It's a good idea to add any other relevant information that be be helpful to your other friendly ShotGrid users such as a description of what the script does that is using this key, the email address of the maintainer, etc.:
+If you'll be using script-based authentication, you need to create a Script entity in Flow Production Tracking. To create a new key, click the + button on the "Scripts" page in the Admin section and give your script a useful name. It's a good idea to add any other relevant information that be be helpful to your other friendly Flow Production Tracking users such as a description of what the script does that is using this key, the email address of the maintainer, etc.:
 
 .. image:: images/scripts_page.png
 
-Once you save your new Script entity, ShotGrid will automatically generate an application key which will act as the script's password. The key will look something like this: ``0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef``.
+Once you save your new Script entity, Flow Production Tracking will automatically generate an application key which will act as the script's password. The key will look something like this: ``0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef``.
 
 Why have different application keys for different scripts?
 ==========================================================
 We recommend you create a new Script entity (and application key) for each script that is using script-based authentication so you can accurately log what scripts are doing what in case one of them causes problems. This will also allow you to better see what scripts are performing what actions in the EventLog. We've found that even though you may *think* you'll probably never need to know, the extra 2 minutes of setup now can prevent hours of headache in the future.
 
 Event Logging
 =============
-By default, events generated by scripts using an script-based authentication are logged in ShotGrid's event log. You can turn this off by un-checking the "Generate Events" checkbox either in the script detail page or from the main Scripts admin page in ShotGrid.
+By default, events generated by scripts using an script-based authentication are logged in Flow Production Tracking's event log. You can turn this off by un-checking the "Generate Events" checkbox either in the script detail page or from the main Scripts admin page in Flow Production Tracking.
 
 .. note:: Turning off event logging will also prevent any email notifications from being triggered by your scripts since the email notifier relies on the event log to find events to notify for.
 
-Scripts using user-based authentication will generate events similarly to if you were performing the same actions in the ShotGrid web application, though there is some additional metadata stored in the ``EventLogEntry`` that identifies the event as created from a script acting on behalf of the user.
+Scripts using user-based authentication will generate events similarly to if you were performing the same actions in the Flow Production Tracking web application, though there is some additional metadata stored in the ``EventLogEntry`` that identifies the event as created from a script acting on behalf of the user.
 
 Why would you want to turn event logging off for scripts?
 ---------------------------------------------------------
-It is an optimization that is not used often, but some users have integration scripts that are pushing data into ShotGrid just for reference, like publishes from their asset management system. This publish data is never changed later, so the data itself has the entire history, and the events would just clutter the event log. The event log can grow very large. So if you have no need to audit the history of what your script does, and it's generating an large amount of event log entries, you may find it's not necessary to create these events.
+It is an optimization that is not used often, but some users have integration scripts that are pushing data into Flow Production Tracking just for reference, like publishes from their asset management system. This publish data is never changed later, so the data itself has the entire history, and the events would just clutter the event log. The event log can grow very large. So if you have no need to audit the history of what your script does, and it's generating an large amount of event log entries, you may find it's not necessary to create these events.
 
 ***********
 Permissions
 ***********
-Users and scripts are both bound by the restrictions of their permission role in ShotGrid. The permission role is assigned by the **Permission Role** field for each entity type.
+Users and scripts are both bound by the restrictions of their permission role in Flow Production Tracking. The permission role is assigned by the **Permission Role** field for each entity type.
 
-For Scripts, the default permission role is "API Admin User" which allows full access to create, update, and delete entities and fields, including editing the "date created" audit field and creating event log entries. If you have other permission roles for ApiUsers, you can set the default role that will be assigned when a new script is created, in your ShotGrid site preferences.
+For Scripts, the default permission role is "API Admin User" which allows full access to create, update, and delete entities and fields, including editing the "date created" audit field and creating event log entries. If you have other permission roles for ApiUsers, you can set the default role that will be assigned when a new script is created, in your Flow Production Tracking site preferences.
 
-When using user-based authentication in your script, it will be bound by the permission role assigned to you in ShotGrid. For example, if you don't have access to edit the status field on Shots, your script won't be able to either. Attempting to perform actions that are prohibited by permissions will raise an appropriate exception.
+When using user-based authentication in your script, it will be bound by the permission role assigned to you in Flow Production Tracking. For example, if you don't have access to edit the status field on Shots, your script won't be able to either. Attempting to perform actions that are prohibited by permissions will raise an appropriate exception.
 
 .. seealso:: `Permissions Documentation <https://help.autodesk.com/view/SGSUB/ENU/?guid=SG_Administrator_ar_site_configuration_ar_permissions_html>`_
 

docs/cookbook.rst

@@ -29,7 +29,7 @@ and paste any of these into your own scripts.
 .. rubric:: Working With Files
 
 You'll probably be doing some work with files at your studio. This is a deep dive into some of 
-the inners of how ShotGrid handles files (also called Attachments) and the different ways to link
+the inners of how Flow Production Tracking handles files (also called Attachments) and the different ways to link
 to them.
 
 .. toctree::
@@ -39,9 +39,9 @@ to them.
 
 .. rubric:: Working With Tasks
 
-Scheduling is a complex beast. ShotGrid can handle lots of different types of functionality around
+Scheduling is a complex beast. Flow Production Tracking can handle lots of different types of functionality around
 scheduling like split tasks, dependencies, and more. These docs walk you through the details of
-how ShotGrid thinks when it's handling Task changes and how you can make your scripts do what you
+how Flow Production Tracking thinks when it's handling Task changes and how you can make your scripts do what you
 need to do.
 
 .. toctree::
@@ -52,7 +52,7 @@ need to do.
 .. rubric:: Smart Cut Fields
 
 Smart Cut Fields are deprecated in favor of the 
-`new cut support added in ShotGrid v7.0 <https://knowledge.autodesk.com/support/shotgrid/learn-explore/caas/CloudHelp/cloudhelp/ENU/SG-Editorial/files/SG-Editorial-ed-cut-schema-html-html.html>`_. 
+`new cut support added in ShotGrid v7.0 <https://knowledge.autodesk.com/support/shotgrid/learn-explore/caas/CloudHelp/cloudhelp/ENU/SG-Editorial/files/SG-Editorial-ed-cut-schema-html-html.html>`_.
 This documentation remains only to support studios who may not have upgraded to the new cut support
 features.