Skip to content

docs: Update README with versioning strategy (box/box-codegen#857) #1100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 3, 2025
Merged

docs: Update README with versioning strategy (box/box-codegen#857) #1100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea77dee
chore: Update `.codegen.json` with commit hash of `codegen` and `open…
box-sdk-build Oct 3, 2025
9a6d9f6
chore: Update `.codegen.json` with commit hash of `codegen` and `open…
box-sdk-build Oct 3, 2025
19957a7
docs: Update README with versioning strategy (box/box-codegen#857)
box-sdk-build Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "9334953", "specHash": "c7acada", "version": "10.0.0" }
{ "engineHash": "7523fdd", "specHash": "fa34496", "version": "10.0.0" }
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,28 @@
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
</p>

# 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)
Expand Down