shotgunsoftware · julien-lang · Sep 9, 2025 · Sep 8, 2025 · Sep 8, 2025 · Sep 8, 2025
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
-[![VFX Platform](https://img.shields.io/badge/vfxplatform-2025%20%7C%202024%20%7C%202023%20%7C%202022-blue.svg)](http://www.vfxplatform.com/)
-[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.10%20%7C%203.9-blue.svg)](https://www.python.org/)/)
-[![Reference Documentation](http://img.shields.io/badge/doc-reference-blue.svg)](http://developer.shotgridsoftware.com/python-api)
+[![Supported VFX Platform: 2022 - 2025](https://img.shields.io/badge/VFX_Platform-2022_|_2023_|_2024_|_2025-blue)](http://www.vfxplatform.com/ "Supported VFX Platform")
+[![Supported Python versions: 3.9 - 3.11](https://img.shields.io/badge/Python-3.9_|_3.10_|_3.11-blue?logo=python&logoColor=f5f5f5)](https://www.python.org/ "Supported Python versions")
+[![Reference Documentation](http://img.shields.io/badge/Reference-documentation-blue.svg?logo=wikibooks&logoColor=f5f5f5)](http://developer.shotgridsoftware.com/python-api)
+
 [![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)
 
@@ -25,13 +26,6 @@ Some useful direct links:
 
 You can see the [full history of the Python API on the documentation site](http://developer.shotgridsoftware.com/python-api/changelog.html).
 
-## Updating HTTPLib2
-
-The API comes with a copy of the `httplib2` inside the `shotgun_api3/lib` folder. To update the copy to a more recent version of the API, you can run the `update_httplib2.py` script at the root of this repository like this:
-
-    python update_httplib2.py vX.Y.Z
-
-where `vX.Y.Z` is a release found on `httplib2`'s [release page](https://github.com/httplib2/httplib2/releases).
 
 ## Tests
 
@@ -47,38 +41,3 @@ Integration and unit tests are provided.
 - `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
-
-### Packaging up new release
-
-1) Update the Changelog in the `HISTORY.rst` file
-    - Add bullet points for any changes that have happened since the previous release. This may include changes you did not make so look at the commit history and make sure we don't miss anything. If you notice something was done that wasn't added to the changelog, hunt down that engineer and make them feel guilty for not doing so. This is a required step in making changes to the API.
-    - Try and match the language of previous change log messages. We want to keep a consistent voice.
-    - Make sure the date of the release matches today. We try and keep this TBD until we're ready to do a release so it's easy to catch that it needs to be updated.
-    - Make sure the version number is filled out and correct. We follow semantic versioning.
-2) Ensure any changes or additions to public methods are documented
-    - Ensure that doc strings are updated in the code itself to work with Sphinx and are correctly formatted.
-    - Examples are always good especially if this a new feature or method.
-    - Think about a new user to the API trying to figure out how to use the features you're documenting.
-3) Update the version value in `python-api/setup.py`  to match the version you are packaging. This controls what version users will get when installing via pip.
-4) Update the `__version__` value in `shotgun_api3/shotgun.py` to the version you're releasing. This identified the current version within the API itself.
-5) Commit these changes in master with a commit message like `packaging for the vx.x.x release`.
-6) Create a tag based off of the master branch called `vx.x.x` to match the version number you're releasing.
-7) Push master and your tag to Github.
-8) Update the Releases page with your new release.
-    - The release should already be there from your tag but if not, create a new one.
-    - Add more detailed information regarding the changes in this release. This is a great place to add examples, and reasons for the change!
-
-### Letting the world know
-Post a message in the [Pipeline Community channel](https://community.shotgridsoftware.com/c/pipeline).
-
-### Prepare for the Next Dev Cycle
-1) Update the `__version__` value in `shotgun_api3/shotgun.py` to the next version number with `.dev` appended to it. For example, `v3.0.24.dev`
-2) Add a new section to the Changelog in the `HISTORY.rst` file with the next version number and a TBD date
-```
-    **v3.0.24 - TBD**
-       + TBD
-```
-3) Commit the changes to master with a commit message like `Bump version to v3.0.24.dev`
-4) Push master to Github
diff --git a/developer/README.md b/developer/README.md
@@ -0,0 +1,44 @@
+
+# Updating HTTPLib2
+
+The API comes with a copy of the `httplib2` inside the `shotgun_api3/lib` folder. To update the copy to a more recent version of the API, you can run the `update_httplib2.py` script at the root of this repository like this:
+
+    python update_httplib2.py vX.Y.Z
+
+where `vX.Y.Z` is a release found on `httplib2`'s [release page](https://github.com/httplib2/httplib2/releases).
+
+
+# Release process
+
+## Packaging up new release
+
+1) Update the Changelog in the `HISTORY.rst` file
+    - Add bullet points for any changes that have happened since the previous release. This may include changes you did not make so look at the commit history and make sure we don't miss anything. If you notice something was done that wasn't added to the changelog, hunt down that engineer and make them feel guilty for not doing so. This is a required step in making changes to the API.
+    - Try and match the language of previous change log messages. We want to keep a consistent voice.
+    - Make sure the date of the release matches today. We try and keep this TBD until we're ready to do a release so it's easy to catch that it needs to be updated.
+    - Make sure the version number is filled out and correct. We follow semantic versioning.
+2) Ensure any changes or additions to public methods are documented
+    - Ensure that doc strings are updated in the code itself to work with Sphinx and are correctly formatted.
+    - Examples are always good especially if this a new feature or method.
+    - Think about a new user to the API trying to figure out how to use the features you're documenting.
+3) Update the version value in `python-api/setup.py`  to match the version you are packaging. This controls what version users will get when installing via pip.
+4) Update the `__version__` value in `shotgun_api3/shotgun.py` to the version you're releasing. This identifies the current version within the API itself.
+5) Commit these changes in master with a commit message like `packaging for the vx.x.x release`.
+6) Create a tag based off of the master branch called `vx.x.x` to match the version number you're releasing.
+7) Push master and your tag to Github.
+8) Update the Releases page with your new release.
+    - The release should already be there from your tag but if not, create a new one.
+    - Add more detailed information regarding the changes in this release. This is a great place to add examples, and reasons for the change!
+
+## Letting the world know
+Post a message in the [Pipeline Community channel](https://community.shotgridsoftware.com/c/pipeline).
+
+## Prepare for the Next Dev Cycle
+1) Update the `__version__` value in `shotgun_api3/shotgun.py` to the next version number with `.dev` appended to it. For example, `v3.0.24.dev`
+2) Add a new section to the Changelog in the `HISTORY.rst` file with the next version number and a TBD date
+```
+    **v3.0.24 - TBD**
+       + TBD
+```
+3) Commit the changes to master with a commit message like `Bump version to v3.0.24.dev`
+4) Push master to Github