From ea77dee2e9a2107dd23f3f037ee0f5c4a30afc4c Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Fri, 3 Oct 2025 03:48:41 -0700 Subject: [PATCH 1/3] chore: Update `.codegen.json` with commit hash of `codegen` and `openapi` spec [skip ci] --- .codegen.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codegen.json b/.codegen.json index 4b505205..45d062f8 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "9334953", "specHash": "c7acada", "version": "10.0.0" } +{ "engineHash": "31fd519", "specHash": "c7acada", "version": "10.0.0" } From 9a6d9f6a35e53384943834ac5702e164841fd4d1 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Fri, 3 Oct 2025 04:48:57 -0700 Subject: [PATCH 2/3] chore: Update `.codegen.json` with commit hash of `codegen` and `openapi` spec [skip ci] --- .codegen.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codegen.json b/.codegen.json index 45d062f8..a8b13350 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "31fd519", "specHash": "c7acada", "version": "10.0.0" } +{ "engineHash": "31fd519", "specHash": "fa34496", "version": "10.0.0" } From 19957a7f0e54eb17421cfbd535ad350c81a62be3 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Fri, 3 Oct 2025 08:46:37 -0700 Subject: [PATCH 3/3] docs: Update README with versioning strategy (box/box-codegen#857) --- .codegen.json | 2 +- README.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/.codegen.json b/.codegen.json index a8b13350..717f836a 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "31fd519", "specHash": "fa34496", "version": "10.0.0" } +{ "engineHash": "7523fdd", "specHash": "fa34496", "version": "10.0.0" } diff --git a/README.md b/README.md index fd823b33..08a417e2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,28 @@ “box-dev-logo”

+# Versioning Strategy + +Starting with v10 of the SDK, we’ve introduced a new generated codebase designed to enhance your experience with the Box API. +It is currently available on the [sdk-gen](https://github.com/box/box-python-sdk/tree/sdk-gen) branch and uses the new `box_sdk_gen` package instead of the old `boxsdk`. + +v10 is targeted at new users of Box Python SDK and users already working with the generated Box Python SDK previously available under the [Box Python SDK Gen repository](https://github.com/box/box-python-sdk-gen). + +For users of v3 of the Box Python SDK, no action is required at this time — we’ll be providing an upcoming v4 release that will include both `boxsdk` and `box_sdk_gen` packages for a smooth migration path. To avoid unintentional upgrades, pin your version to `boxsdk~=3.0`. + +For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/). + +--- + +## Which Version Should I Use? + +| Scenario | Recommended Version | Example `pip install` | +| --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | --------------------------- | +| Creating a new application | Use [v10](https://github.com/box/box-python-sdk/tree/sdk-gen) | `pip install "boxsdk>=10"` | +| Existing app using [box-sdk-gen](https://pypi.org/project/box-sdk-gen/) artifact | Upgrade to [v10](https://github.com/box/box-python-sdk/tree/sdk-gen) | `pip install "boxsdk>=10"` | +| Existing app using [boxsdk](https://pypi.org/project/boxsdk/) artifact planning to use new features | Wait for v4 to start migration process | TBD | +| Existing app using [boxsdk](https://pypi.org/project/boxsdk/) artifact not planning any changes | Stay on `boxsdk~=3.0` | `pip install "boxsdk~=3.0"` | + # Box Python SDK [![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)