rename camelCase params to snake_case with deprecation shims

.github/workflows/ci.yml

@@ -29,6 +29,11 @@ jobs:
       - name: flake8
         run: flake8 .
 
+      - name: snake_case
+        # check_snake_case.py owns the include/exclude rules; pass it everything
+        # under domino/ and it will skip paths that don't apply. Keeps CI in
+        # lockstep with the pre-commit hook (both invoke the same script).
+        run: find domino -name "*.py" | xargs python scripts/check_snake_case.py
 
   typecheck:
     name: Type check

CHANGELOG.md

@@ -9,6 +9,36 @@ All notable changes to the `python-domino` library will be documented in this fi
 * GitHub Actions CI workflow (`.github/workflows/ci.yml`) that runs lint, type-checking, and tests on every PR and push to `master`. All checks must pass before a PR can be merged.
 * `pyproject.toml` with `isort` and `black` configuration (`profile = "black"`, `target-version = ["py310"]`).
 
+### Deprecated
+The following public API parameters have been renamed to follow PEP 8 (`snake_case`).
+The old names continue to work but will emit a `DeprecationWarning`. They will be
+removed in the next major version.
+
+> **Note:** these renames are Python-side only. The JSON keys sent to the
+> Domino HTTP API are unchanged — the SDK still emits `commitId`, `isDirect`,
+> `hardwareTierId`, etc. on the wire. The HTTP API contract is not affected.
+
+| Method | Old name | New name |
+|--------|----------|----------|
+| `runs_start`, `runs_start_blocking` | `isDirect` | `is_direct` |
+| `runs_start`, `runs_start_blocking` | `commitId` | `commit_id` |
+| `runs_start`, `runs_start_blocking` | `publishApiEndpoint` | `publish_api_endpoint` |
+| `run_stop` | `runId` | `run_id` |
+| `run_stop` | `saveChanges` | `save_changes` |
+| `runs_status` | `runId` | `run_id` |
+| `get_run_log` | `runId` | `run_id` |
+| `get_run_log` | `includeSetupLog` | `include_setup_log` |
+| `runs_stdout` | `runId` | `run_id` |
+| `files_list` | `commitId` | `commit_id` |
+| `endpoint_publish` | `commitId` | `commit_id` |
+| `app_publish` | `unpublishRunningApps` | `unpublish_running_apps` |
+| `app_publish` | `hardwareTierId` | `hardware_tier_id` |
+| `app_publish` | `environmentId` | `environment_id` |
+| `app_publish` | `externalVolumeMountIds` | `external_volume_mount_ids` |
+| `app_publish` | `commitId` | `commit_id` |
+| `app_publish` | `appId` | `app_id` |
+| `app_unpublish` | `appId` | `app_id` |
+
 ### Changed
 * Resolved all 38 pre-existing `mypy` type errors across `domino/`, bringing the codebase to a clean `mypy` pass with `--python-version=3.10`.
 * Resolved all `flake8`, `isort`, and `black` formatting errors across the codebase.

README.adoc

@@ -577,7 +577,7 @@ d.app_publish(commit_id="abc123def456")
 d.app_publish(app_id="aabbccddeeff001122334457")
 ----
 
-NOTE: The parameters `unpublishRunningApps`, `hardwareTierId`, `environmentId`, `externalVolumeMountIds`, `commitId`, and `appId` are deprecated and will be removed in the next major version. Use the `snake_case` equivalents listed above.
+NOTE: The parameters `unpublishRunningApps`, `hardwareTierId`, `environmentId`, `externalVolumeMountIds`, `commitId`, and `appId` are deprecated and will be removed in the next major version. Use the `snake_case` equivalents listed above. These renames are Python-side only — the JSON keys sent to the Domino HTTP API are unchanged (the SDK still emits `commitId`, `hardwareTierId`, etc. on the wire). The HTTP API contract is not affected.
 
 ==== app_unpublish(app_id=None)
 

README.md

@@ -608,6 +608,11 @@ d.app_publish(app_id="aabbccddeeff001122334457")
 > `environmentId`, `externalVolumeMountIds`, `commitId`, and `appId`
 > are deprecated and will be removed in the next major version.
 > Use the `snake_case` equivalents listed above.
+>
+> These renames are Python-side only — the JSON keys sent to the
+> Domino HTTP API are unchanged (the SDK still emits `commitId`,
+> `hardwareTierId`, etc. on the wire). The HTTP API contract is
+> not affected.
 
 ### app_unpublish(app_id=None)