Skip to content

Commit c6f8ab8

Browse files
docs: Update README with versioning strategy (box/box-codegen#857) (#1100)
1 parent 5c21907 commit c6f8ab8

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "9334953", "specHash": "c7acada", "version": "10.0.0" }
1+
{ "engineHash": "7523fdd", "specHash": "fa34496", "version": "10.0.0" }

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,28 @@
22
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
33
</p>
44

5+
# Versioning Strategy
6+
7+
Starting with v10 of the SDK, we’ve introduced a new generated codebase designed to enhance your experience with the Box API.
8+
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`.
9+
10+
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).
11+
12+
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`.
13+
14+
For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/).
15+
16+
---
17+
18+
## Which Version Should I Use?
19+
20+
| Scenario | Recommended Version | Example `pip install` |
21+
| --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | --------------------------- |
22+
| Creating a new application | Use [v10](https://github.com/box/box-python-sdk/tree/sdk-gen) | `pip install "boxsdk>=10"` |
23+
| 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"` |
24+
| Existing app using [boxsdk](https://pypi.org/project/boxsdk/) artifact planning to use new features | Wait for v4 to start migration process | TBD |
25+
| Existing app using [boxsdk](https://pypi.org/project/boxsdk/) artifact not planning any changes | Stay on `boxsdk~=3.0` | `pip install "boxsdk~=3.0"` |
26+
527
# Box Python SDK
628

729
[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)

0 commit comments

Comments
 (0)