You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-17Lines changed: 19 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@
16
16
-[Supported versions](#supported-versions)
17
17
-[Version v4](#version-v4)
18
18
-[Version v10](#version-v10)
19
+
-[Deprecation of `boxsdk` package](#deprecation-of-boxsdk-package)
19
20
-[Which Version Should I Use?](#which-version-should-i-use)
20
21
-[Installing](#installing)
21
22
-[Getting Started](#getting-started)
@@ -44,10 +45,6 @@ The `box_sdk_gen` package is available in two major supported versions: v4 and v
44
45
In v4 of the Box Python SDK, we are introducing a version that consolidates both the manually written package (`boxsdk`)
45
46
and the new generated package (`box_sdk_gen`). This allows developers to use both packages simultaneously within a single project.
46
47
47
-
Version v4 of the Box Python SDK will be supported until 2027. During this period,
48
-
the `boxsdk` package will be marked as deprecated and will receive only bug fixes and security patches.
49
-
All new features and support for new Box APIs will be provided exclusively in the `box_sdk_gen` package.
50
-
51
48
The codebase for v4 of the Box Python SDK is currently available on the [combined-sdk](https://github.com/box/box-python-sdk/tree/combined-sdk) branch.
52
49
Migration guide which would help with migration from `boxsdk` to `box_sdk_gen` can be found [here](./migration-guides/from-boxsdk-to-box_sdk_gen.md).
53
50
@@ -64,6 +61,11 @@ Version v10 is intended for:
64
61
- New users of the Box Python SDK.
65
62
- Developers 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).
66
63
64
+
## Deprecation of `boxsdk` package
65
+
66
+
The `boxsdk` package will be marked as deprecated, will receive only bug fixes and security patches, and reach end of support in 2027.
67
+
All new features and support for new Box APIs will be provided exclusively in the `box_sdk_gen` package.
68
+
67
69
## Which Version Should I Use?
68
70
69
71
| Scenario | Recommended Version | Example `pip install`|
@@ -77,7 +79,7 @@ For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://
77
79
78
80
# Installing
79
81
80
-
To install Box Python SDK v4 version that consolidates both the manual package (`boxsdk`)
82
+
To install Box Python SDK v4 version that consolidates both the manual package (`boxsdk`)
81
83
and the new generated package (`box_sdk_gen`) run the command:
82
84
83
85
```console
@@ -93,7 +95,7 @@ Supported Python versions are Python 3.8 and above.
93
95
94
96
# Getting Started
95
97
96
-
To get started with the SDK, get a Developer Token from the Configuration page of your app in the [Box Developer Console](https://app.box.com/developers/console).
98
+
To get started with the SDK, get a Developer Token from the Configuration page of your app in the [Box Developer Console](https://app.box.com/developers/console).
97
99
Developer Tokens are short-lived and expire after 60 minutes, which is good for testing but not for production use.
98
100
To learn about other authentication methods, see the [Authentication](#authentication) section below.
99
101
@@ -139,7 +141,7 @@ if __name__ == '__main__':
139
141
140
142
# Authentication
141
143
142
-
Both the `box_sdk_gen` and `boxsdk` packages support multiple authentication methods, including
144
+
Both the `box_sdk_gen` and `boxsdk` packages support multiple authentication methods, including
143
145
Developer Token, OAuth 2.0, Client Credentials Grant, and JSON Web Token (JWT).
144
146
145
147
You can find detailed instructions and example code for each authentication method in the following documentation:
@@ -188,21 +190,21 @@ Migration guides which help you to migrate to supported major SDK versions can b
188
190
We use a modified version of [Semantic Versioning](https://semver.org/) for all changes. See [version strategy](VERSIONS.md) for details which is effective from 30 July 2022.
189
191
190
192
A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features.
191
-
Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often).
192
-
At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade.
193
+
Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often).
194
+
At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade.
193
195
194
-
We always recommend that all users run the latest available minor release for whatever major version is in use.
196
+
We always recommend that all users run the latest available minor release for whatever major version is in use.
195
197
We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.
196
198
197
199
## Version schedule
198
200
199
-
| Version | Supported Environments | State | First Release | EOL/Terminated |
0 commit comments