sg-python-api 0.1.0__py3-none-any.whl

sg_python_api-0.1.0.dist-info/METADATA

@@ -0,0 +1,177 @@
+Metadata-Version: 2.5
+Name: sg-python-api
+Version: 0.1.0
+Summary: Python client for Autodesk Flow Production Tracking
+Project-URL: Documentation, https://github.com/dactylo/sg-python-api/tree/main/docs
+Project-URL: Homepage, https://github.com/dactylo/sg-python-api
+Project-URL: Issues, https://github.com/dactylo/sg-python-api/issues
+Project-URL: Repository, https://github.com/dactylo/sg-python-api
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,flow-production-tracking,shotgrid,shotgun,shotgun-api3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: urllib3<3,>=2
+Provides-Extra: async
+Requires-Dist: httpx2<3,>=2; extra == 'async'
+Description-Content-Type: text/markdown
+
+# sg-python-api
+
+sg-python-api is a Python client for Autodesk Flow Production Tracking, written for pipeline tools
+and scripts built on Autodesk's `shotgun_api3` client. It keeps the same import name and documented
+API, so an existing integration can switch without rewriting its calls and gain shared connections,
+bounded network waits, and retries that do not repeat an ambiguous write. It also adds a native
+asynchronous client.
+
+This documentation uses SG for Flow Production Tracking, formerly named Shotgun and ShotGrid.
+
+## Why use it?
+
+- **Reuse connections:** share one synchronous client across threads, or one async client across
+  tasks on the same event loop.
+- **Bound network waits:** default connect and read timeouts help applications recover from an
+  unavailable service.
+- **Handle writes carefully:** retries account for whether an operation is safe to repeat. An
+  ambiguous write is left for the application to reconcile.
+- **Test without a site:** synchronous and asynchronous `mockgun` clients provide an in-memory API
+  for application tests.
+
+sg-python-api is an independent implementation of the documented API of Autodesk's Python client
+`3.10.2`. Some behavior differs on purpose, so validate your application's workflows against a test
+site before replacing its production client. The [migration guide](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/migration-guide.md) walks
+through the switch, and the [compatibility reference](https://github.com/dactylo/sg-python-api/blob/v0.1.0/COMPATIBILITY.md) lists the differences.
+
+## Installation
+
+You need Python 3.11 or newer and an SG site running server version 7.10.0 or newer. Authenticated
+requests to a remote site require HTTPS.
+
+`sg-python-api` and Autodesk's `shotgun-api3` both install the `shotgun_api3` package, so install
+exactly one of them in a Python environment. If the official client is already installed, follow
+the [migration steps](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/migration-guide.md#install-the-replacement) to replace it.
+
+When a release is available on your package index, install into the Python environment that runs
+your application:
+
+```sh
+python -m pip install sg-python-api
+```
+
+To install from a checkout instead, run:
+
+```sh
+python -m pip install .
+```
+
+The base installation provides the synchronous `Shotgun` client and both `mockgun` test clients. To
+use the native asynchronous client, `AsyncShotgun`, install the `async` extra, which adds the
+`httpx2` HTTP library:
+
+```sh
+python -m pip install 'sg-python-api[async]'
+```
+
+From a checkout, use:
+
+```sh
+python -m pip install '.[async]'
+```
+
+## Quick start
+
+These examples read one project from your site. They take the site URL and script credentials from
+environment variables so the API key stays out of source code; the client does not read these
+variables itself. Set `SHOTGUN_URL` to your site's HTTPS URL, and set `SHOTGUN_SCRIPT_NAME` and
+`SHOTGUN_API_KEY` to a script account that can read projects.
+
+### Synchronous client
+
+```python
+import os
+
+from shotgun_api3 import Shotgun
+
+sg = Shotgun(
+    os.environ['SHOTGUN_URL'],
+    script_name=os.environ['SHOTGUN_SCRIPT_NAME'],
+    api_key=os.environ['SHOTGUN_API_KEY'],
+)
+try:
+    project = sg.find_one('Project', [], ['name'])
+    print(project)
+finally:
+    sg.close()
+```
+
+The script prints a project dictionary containing `type`, `id`, and `name`, or `None` when no
+project is visible to that account. You can share one `Shotgun` client across threads; `close()`
+releases its pooled connections when you no longer need it.
+
+### Asynchronous client
+
+With the `async` extra installed and the same environment variables set, run:
+
+```python
+import asyncio
+import os
+
+from shotgun_api3 import AsyncShotgun
+
+
+async def main() -> None:
+    async with AsyncShotgun(
+        os.environ['SHOTGUN_URL'],
+        script_name=os.environ['SHOTGUN_SCRIPT_NAME'],
+        api_key=os.environ['SHOTGUN_API_KEY'],
+    ) as sg:
+        project = await sg.find_one('Project', [], ['name'])
+        print(project)
+
+
+asyncio.run(main())
+```
+
+The output matches the synchronous example. The `async with` block closes the client even when an
+operation fails. Without the `async` extra, importing `AsyncShotgun` raises `ImportError`.
+
+Share an `AsyncShotgun` only among tasks on one event loop, and cancel its work by cancelling the
+task. A cancelled write may already have reached the server, so check its outcome before repeating
+it. The [async reference](https://github.com/dactylo/sg-python-api/blob/v0.1.0/COMPATIBILITY.md#async-extension-surfaces) covers shutdown and
+cancellation in detail.
+
+## Documentation
+
+| If you want to...                                     | Read                                                                               |
+| ----------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| Replace Autodesk's client in an existing application  | [Migration guide](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/migration-guide.md)                                         |
+| Check what behaves differently from Autodesk's client | [Compatibility](https://github.com/dactylo/sg-python-api/blob/v0.1.0/COMPATIBILITY.md)                                                  |
+| Tune pooling and page prefetch, or observe requests   | [Configuration extensions](https://github.com/dactylo/sg-python-api/blob/v0.1.0/COMPATIBILITY.md#configuration-and-observer-extensions) |
+| Confirm which client loads and run a smoke test       | [Testing an installation](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/testing.md)                                         |
+| Compare measured latency and transfer memory          | [Benchmarks](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/benchmarks.md)                                                   |
+| See changes by version                                | [Changelog](https://github.com/dactylo/sg-python-api/blob/v0.1.0/CHANGELOG.md)                                                          |
+
+## Development
+
+See the [development guide](https://github.com/dactylo/sg-python-api/blob/v0.1.0/docs/development.md) for the required tools, CI, and dependency locks.
+With those tools installed, run:
+
+```sh
+make setup
+make check
+```
+
+`make check` also runs the live-site tests, which create and delete records, whenever the
+`SG_TEST_*` variables described in the development guide are set.
+
+## License
+
+sg-python-api is available under the [MIT License](https://github.com/dactylo/sg-python-api/blob/v0.1.0/LICENSE). It is an independent project and is
+not affiliated with or endorsed by Autodesk. Flow Production Tracking is a product of Autodesk,
+Inc.

sg_python_api-0.1.0.dist-info/RECORD

@@ -0,0 +1,31 @@
+shotgun_api3/__init__.py,sha256=fviJGOi_Gb9jHi5Q9ty5tIbeIvxMtLNrKx_4HJVgemI,2011
+shotgun_api3/_async_client.py,sha256=or11Le6Y2WB3TVTVj_7QiLfOLpDbwjs1p3VVAQhFHLQ,111070
+shotgun_api3/_async_driver.py,sha256=ldrETCNgihOcuoGYVqt8M4u2R1euNkvp3TRXLYQbzJ0,32838
+shotgun_api3/_async_httpx2.py,sha256=3pjeFsb5racGArvlR50c3w0XtrttXuRU_6E9Y-cBU3c,24387
+shotgun_api3/_async_transport.py,sha256=8iAcoFafEHKRBirBkqdIqMFgqLs1YTgtzgACudD0kM4,4928
+shotgun_api3/_capabilities.py,sha256=RrStvExVC3TAADhfbY2JpYZUXmvE63vXIJy1R-nkEII,5527
+shotgun_api3/_client.py,sha256=n4lbXG9UxQhrv1IhwsJd8dD41JIq_Xh-_zqDueSguW8,100184
+shotgun_api3/_config.py,sha256=hCKJtaO06wZFJEz-yIw2SagDeWqZMHpuqSmS33qG2Q4,55264
+shotgun_api3/_crud.py,sha256=Ax36jA2E-lauRf2D-2rmRDj61SilOygtkjKgs5XDCUs,30319
+shotgun_api3/_driver.py,sha256=sPkiseKisJTMSNAxkCvdGXc_H1kKS6sg-rJQLKXSVgU,30139
+shotgun_api3/_errors.py,sha256=fk7v3XbmZK63M272r5wDwF_GgI-4RynPfAWv1P-J-GI,1480
+shotgun_api3/_execution.py,sha256=Kn2Yd9sXIA975stnof7MeuA8bT3dyOuWDIqQnP65LO0,8235
+shotgun_api3/_files.py,sha256=a1PfHKV4OMi6j7BQG2rkMPCcaNTB5uAWNiqCh64AEXg,35223
+shotgun_api3/_methods.py,sha256=8dD5BUN_5hnGAYomUEAX1dHZnI4Cliid6PrrP8AhhPI,36132
+shotgun_api3/_protocol.py,sha256=dKr1XqB6Xo56QloZ2MAyN4ulqYkTjw8VYeJRd5QHufQ,45286
+shotgun_api3/_sentinel.py,sha256=KAQzQjJVhTTZPLFY1f88-_vP7U06i2g6ZS7KJcn4vIA,116
+shotgun_api3/_sg_timezone.py,sha256=yr7Wdln9fwfTVGMQSFsgO-eduuTHQ5EbSY5xEVQ2tYw,115
+shotgun_api3/_signatures.py,sha256=_yhNnbkVF-0opaBfg9H6SauBN2RT4hJsHGa3ZO3Ug4s,1622
+shotgun_api3/_transport.py,sha256=LmQ0e2VvAKwFdNy4SyfRHwgKC6GWnwkIN5Wa2fin3AM,30047
+shotgun_api3/_version.py,sha256=yK498PuHvOUCFnIC1QKSqvFXzUBBuOMHBsVo5gSpFCE,102
+shotgun_api3/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+shotgun_api3/shotgun.py,sha256=X7PLlCC-gR8dJgY_uLYXw_LWN8mz5MsQsSYJldtavTk,1706
+shotgun_api3/lib/__init__.py,sha256=4WGYod6xHcj23rapx5bTDGdjT52H1CAQNMz4BmzNmn0,55
+shotgun_api3/lib/sgtimezone.py,sha256=nYSaCsIeq_SJh7YgL4yWN7dTVVz9lAfx-G3mzsHb8iM,7027
+shotgun_api3/lib/mockgun/__init__.py,sha256=2mHjMJAV4mZ8JvnP8WHn6tkdMJoB7UQtNSs99YzNW30,703
+shotgun_api3/lib/mockgun/_async.py,sha256=7bTZFdlSzeoGq9fRbPBAf-X08qDmrkzV9rxskx5AGX8,10812
+shotgun_api3/lib/mockgun/_mockgun.py,sha256=k2cqLMCKpU5oIbUGiYulf1aIU0HLrMB6DQQ3KrCy7WQ,65093
+sg_python_api-0.1.0.dist-info/METADATA,sha256=7Wzieh6ix8BwZJ_oD-B4_G-bO6m5pPDr1wzC5EFYhUQ,7789
+sg_python_api-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+sg_python_api-0.1.0.dist-info/licenses/LICENSE,sha256=V3moMsQxKDchTd3mtXl5J-ODaNBDvFrapOf1DK7Nx_U,1082
+sg_python_api-0.1.0.dist-info/RECORD,,

sg_python_api-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

sg_python_api-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 the sg-python-api authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

shotgun_api3/__init__.py

@@ -0,0 +1,68 @@
+"""Provide compatible synchronous and optional asynchronous Shotgun clients.
+
+Import `Shotgun` directly from this package. Import `AsyncShotgun` explicitly
+after installing the `async` extra; it is loaded lazily and excluded from star
+imports.
+
+Close synchronous clients with `close()`. Use asynchronous clients through an
+async context manager or call `await close()`. The public `sg_timezone` object
+is the shared timezone configuration used for datetime conversion.
+"""
+
+import importlib
+from typing import TYPE_CHECKING
+
+from .shotgun import SG_TIMEZONE as _SG_TIMEZONE
+from .shotgun import (
+    AuthenticationFault,
+    Error,
+    Fault,
+    MissingTwoFactorAuthenticationFault,
+    ProtocolError,
+    ResponseError,
+    Shotgun,
+    ShotgunError,
+    ShotgunFileDownloadError,
+    ShotgunThumbnailNotReady,
+    UserCredentialsNotAllowedForSSOAuthenticationFault,
+    __version__,
+)
+
+if TYPE_CHECKING:
+    from ._async_client import AsyncShotgun as AsyncShotgun
+
+sg_timezone = _SG_TIMEZONE
+
+__all__ = [
+    'AuthenticationFault',
+    'Error',
+    'Fault',
+    'MissingTwoFactorAuthenticationFault',
+    'ProtocolError',
+    'ResponseError',
+    'Shotgun',
+    'ShotgunError',
+    'ShotgunFileDownloadError',
+    'ShotgunThumbnailNotReady',
+    'UserCredentialsNotAllowedForSSOAuthenticationFault',
+    '__version__',
+    'sg_timezone',
+]
+
+
+def __getattr__(name: str) -> object:
+    """Resolve optional package exports without loading them on base import."""
+    if name != 'AsyncShotgun':
+        raise AttributeError(f'module {__name__!r} has no attribute {name!r}')
+    try:
+        importlib.import_module('httpx2')
+    except ModuleNotFoundError as exc:
+        if exc.name != 'httpx2':
+            raise
+        raise ImportError(
+            "AsyncShotgun requires httpx2 from the 'async' extra: install sg-python-api[async]"
+        ) from exc
+    module = importlib.import_module(f'{__name__}._async_client')
+    exported = getattr(module, name)
+    globals()[name] = exported
+    return exported