sg-python-api 0.1.1__tar.gz → 0.2.0__tar.gz

{sg_python_api-0.1.1 → sg_python_api-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sg-python-api
-Version: 0.1.1
+Version: 0.2.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
@@ -44,9 +44,9 @@ This documentation uses SG for Flow Production Tracking, formerly named Shotgun
   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.1/docs/migration-guide.md) walks
-through the switch, and the [compatibility reference](https://github.com/dactylo/sg-python-api/blob/v0.1.1/COMPATIBILITY.md) lists the differences.
+`3.10.5`. 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.2.0/docs/migration-guide.md) walks
+through the switch, and the [compatibility reference](https://github.com/dactylo/sg-python-api/blob/v0.2.0/COMPATIBILITY.md) lists the differences.
 
 ## Installation
 
@@ -55,7 +55,7 @@ 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.1/docs/migration-guide.md#install-the-replacement) to replace it.
+the [migration steps](https://github.com/dactylo/sg-python-api/blob/v0.2.0/docs/migration-guide.md#install-the-replacement) to replace it.
 
 From a checkout, install into the Python environment that runs your application:
 
@@ -126,39 +126,36 @@ 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.1/COMPATIBILITY.md#async-extension-surfaces) covers shutdown and
-cancellation in detail.
+operation fails. Share an `AsyncShotgun` only among tasks on one event loop. See the
+[async reference](https://github.com/dactylo/sg-python-api/blob/v0.2.0/COMPATIBILITY.md#async-extension-surfaces) for lifecycle and cancellation
+details.
 
 ## 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.1/docs/migration-guide.md)                                         |
-| Check what behaves differently from Autodesk's client | [Compatibility](https://github.com/dactylo/sg-python-api/blob/v0.1.1/COMPATIBILITY.md)                                                  |
-| Tune pooling and page prefetch, or observe requests   | [Configuration extensions](https://github.com/dactylo/sg-python-api/blob/v0.1.1/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.1/docs/testing.md)                                         |
-| Compare measured latency and transfer memory          | [Benchmarks](https://github.com/dactylo/sg-python-api/blob/v0.1.1/docs/benchmarks.md)                                                   |
-| See changes by version                                | [Changelog](https://github.com/dactylo/sg-python-api/blob/v0.1.1/CHANGELOG.md)                                                          |
+| If you want to...                                                  | Read                                                                               |
+| ------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |
+| Replace Autodesk's client in an existing application               | [Migration guide](https://github.com/dactylo/sg-python-api/blob/v0.2.0/docs/migration-guide.md)                                         |
+| Check what behaves differently from Autodesk's client              | [Compatibility](https://github.com/dactylo/sg-python-api/blob/v0.2.0/COMPATIBILITY.md)                                                  |
+| Tune pooling, TCP keepalive, or page prefetch, or observe requests | [Configuration extensions](https://github.com/dactylo/sg-python-api/blob/v0.2.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.2.0/docs/testing.md)                                         |
+| Compare measured latency and transfer memory                       | [Benchmarks](https://github.com/dactylo/sg-python-api/blob/v0.2.0/docs/benchmarks.md)                                                   |
+| See changes by version                                             | [Changelog](https://github.com/dactylo/sg-python-api/blob/v0.2.0/CHANGELOG.md)                                                          |
 
 ## Development
 
-See the [development guide](https://github.com/dactylo/sg-python-api/blob/v0.1.1/docs/development.md) for the required tools, CI, and dependency locks.
+See the [development guide](https://github.com/dactylo/sg-python-api/blob/v0.2.0/docs/development.md) for the required tools, CI, and dependency locks.
 With those tools installed, run:
 
 ```sh
 make setup
-make check
+make check TEST_FLAGS="-m 'not live'"
 ```
 
-`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.
+See [live-site tests](https://github.com/dactylo/sg-python-api/blob/v0.2.0/docs/development.md#live-site-tests) to configure tests that create and
+retire records on a disposable site.
 
 ## License
 
-sg-python-api is available under the [MIT License](https://github.com/dactylo/sg-python-api/blob/v0.1.1/LICENSE). It is an independent project and is
+sg-python-api is available under the [MIT License](https://github.com/dactylo/sg-python-api/blob/v0.2.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.1 → sg_python_api-0.2.0}/README.md

@@ -20,7 +20,7 @@ This documentation uses SG for Flow Production Tracking, formerly named Shotgun
   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
+`3.10.5`. Some behavior differs on purpose, so validate your application's workflows against a test
 site before replacing its production client. The [migration guide](docs/migration-guide.md) walks
 through the switch, and the [compatibility reference](COMPATIBILITY.md) lists the differences.
 
@@ -102,23 +102,20 @@ 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](COMPATIBILITY.md#async-extension-surfaces) covers shutdown and
-cancellation in detail.
+operation fails. Share an `AsyncShotgun` only among tasks on one event loop. See the
+[async reference](COMPATIBILITY.md#async-extension-surfaces) for lifecycle and cancellation
+details.
 
 ## Documentation
 
-| If you want to...                                     | Read                                                                               |
-| ----------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| Replace Autodesk's client in an existing application  | [Migration guide](docs/migration-guide.md)                                         |
-| Check what behaves differently from Autodesk's client | [Compatibility](COMPATIBILITY.md)                                                  |
-| Tune pooling and page prefetch, or observe requests   | [Configuration extensions](COMPATIBILITY.md#configuration-and-observer-extensions) |
-| Confirm which client loads and run a smoke test       | [Testing an installation](docs/testing.md)                                         |
-| Compare measured latency and transfer memory          | [Benchmarks](docs/benchmarks.md)                                                   |
-| See changes by version                                | [Changelog](CHANGELOG.md)                                                          |
+| If you want to...                                                  | Read                                                                               |
+| ------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |
+| Replace Autodesk's client in an existing application               | [Migration guide](docs/migration-guide.md)                                         |
+| Check what behaves differently from Autodesk's client              | [Compatibility](COMPATIBILITY.md)                                                  |
+| Tune pooling, TCP keepalive, or page prefetch, or observe requests | [Configuration extensions](COMPATIBILITY.md#configuration-and-observer-extensions) |
+| Confirm which client loads and run a smoke test                    | [Testing an installation](docs/testing.md)                                         |
+| Compare measured latency and transfer memory                       | [Benchmarks](docs/benchmarks.md)                                                   |
+| See changes by version                                             | [Changelog](CHANGELOG.md)                                                          |
 
 ## Development
 
@@ -127,11 +124,11 @@ With those tools installed, run:
 
 ```sh
 make setup
-make check
+make check TEST_FLAGS="-m 'not live'"
 ```
 
-`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.
+See [live-site tests](docs/development.md#live-site-tests) to configure tests that create and
+retire records on a disposable site.
 
 ## License
 

{sg_python_api-0.1.1 → sg_python_api-0.2.0}/pyproject.toml

@@ -10,7 +10,7 @@ requires = [ "editables~=0.3", "hatch-fancy-pypi-readme>=25.1", "hatchling>=1.27
 # ==========================================================
 [project]
 name = "sg-python-api"
-version = "0.1.1"
+version = "0.2.0"
 description = "Python client for Autodesk Flow Production Tracking"
 keywords = [ "api", "flow-production-tracking", "shotgrid", "shotgun", "shotgun-api3" ]
 license = "MIT"
@@ -50,6 +50,7 @@ dev = [
   "pyproject-fmt",
   "pyright",
   "ruff",
+  "zizmor",
   { include-group = "test" },
 ]
 test = [
@@ -67,13 +68,7 @@ metadata.hooks.fancy-pypi-readme.fragments = [ { path = "README.md" } ]
 build.targets.wheel.packages = [ "src/shotgun_api3" ]
 build.targets.sdist.include = [
   "/README.md",
-  "/COMPATIBILITY.md",
-  "/docs/*.md",
-  "/examples/**",
-  "/Makefile",
-  "/scripts/**",
-  "/src/**",
-  "/tests/**",
+  "/src",
 ]
 
 # Keep checkout links relative; package links target this release.
@@ -114,11 +109,11 @@ lint.ignore = [
 # Command-line scripts and examples intentionally print output.
 lint.per-file-ignores."examples/**/*.py" = [ "T201" ]
 lint.per-file-ignores."scripts/**/*.py" = [ "T201" ]
-# Repeated same-file collaboration follows module-boundary privacy.
-lint.per-file-ignores."scripts/benchmark.py" = [ "SLF001" ]
-lint.per-file-ignores."src/shotgun_api3/_async_client.py" = [ "SLF001" ]
-lint.per-file-ignores."src/shotgun_api3/_config.py" = [ "SLF001" ]
-lint.per-file-ignores."src/shotgun_api3/_transport.py" = [ "SLF001" ]
+# Public signatures mirror shotgun_api3
+lint.per-file-ignores."src/shotgun_api3/_async_client.py" = [ "PLR0913", "PLR0917" ]
+lint.per-file-ignores."src/shotgun_api3/_client.py" = [ "PLR0913", "PLR0917" ]
+lint.per-file-ignores."src/shotgun_api3/lib/mockgun/_async_client.py" = [ "PLR0913", "PLR0917" ]
+lint.per-file-ignores."src/shotgun_api3/lib/mockgun/_sync_client.py" = [ "PLR0913", "PLR0917" ]
 lint.per-file-ignores."tests/**/*.py" = [
   "D",       # No docstrings required in tests
   "PLR2004", # Allow magic values in tests
@@ -137,7 +132,10 @@ max_supported_python = "3.15"
 # ==========================================================
 [tool.pyright]
 pythonVersion = "3.11"  # Keep in sync with tool.ruff.target-version
+venv = ".venv"  # Created by make setup
+venvPath = "."
 typeCheckingMode = "strict"
+exclude = [ "dist" ]
 extraPaths = [ ".", "src" ]
 executionEnvironments = [
   { root = "tests", reportPrivateUsage = "none" },

{sg_python_api-0.1.1 → sg_python_api-0.2.0}/src/shotgun_api3/__init__.py

@@ -4,6 +4,10 @@ Import `Shotgun` directly from this package. Import `AsyncShotgun` explicitly
 after installing the `async` extra; it is loaded lazily and excluded from star
 imports.
 
+Import initializes the compatibility logger and reads
+`SHOTGUN_API_DISABLE_ENTITY_OPTIMIZATION`; the value `1` disables entity-link
+optimization.
+
 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.