|
2 | 2 | <img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%"> |
3 | 3 | </p> |
4 | 4 |
|
5 | | -# Box Python SDK |
| 5 | +# Box Python SDK v4 |
6 | 6 |
|
7 | 7 | [](http://opensource.box.com/badges) |
8 | 8 | [](https://github.com/box/box-python-sdk/actions) |
|
13 | 13 | <!-- START doctoc generated TOC please keep comment here to allow auto update --> |
14 | 14 | <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
15 | 15 |
|
| 16 | +- [Introduction](#introduction) |
16 | 17 | - [Supported versions](#supported-versions) |
17 | 18 | - [Version v4](#version-v4) |
18 | 19 | - [Version v10](#version-v10) |
|
35 | 36 |
|
36 | 37 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> |
37 | 38 |
|
| 39 | +# Introduction |
| 40 | + |
| 41 | +We are excited to introduce the v4 major release of the Box Python SDK, |
| 42 | +designed to elevate the developer experience and streamline your integration with the Box Content Cloud. |
| 43 | + |
| 44 | +With this SDK version, alongside the existing `boxsdk` package, we’re introducing a new `box_sdk_gen` package, which gives you access to: |
| 45 | + |
| 46 | +1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications. |
| 47 | +2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay. |
| 48 | +3. Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process. |
| 49 | +4. Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more. |
| 50 | +5. Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic. |
| 51 | + |
| 52 | +Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud. |
| 53 | + |
38 | 54 | # Supported versions |
39 | 55 |
|
40 | | -To enhance developer experience, provide full Box API coverage, and rapid updates we have introduced the new generated codebase through the `box_sdk_gen` package. |
| 56 | +To enhance developer experience, we have introduced the new generated codebase through the `box_sdk_gen` package. |
41 | 57 | The `box_sdk_gen` package is available in two major supported versions: v4 and v10. |
42 | 58 |
|
43 | 59 | ## Version v4 |
@@ -72,7 +88,7 @@ All new features and support for new Box APIs will be provided exclusively in th |
72 | 88 | |------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|-----------------------------| |
73 | 89 | | Creating a new application | Use [v10](https://github.com/box/box-python-sdk/tree/sdk-gen) | `pip install "boxsdk>=10"` | |
74 | 90 | | App using [box-sdk-gen](https://pypi.org/project/box-sdk-gen/) artifact | Migrate to [v10](https://github.com/box/box-python-sdk/tree/sdk-gen) | `pip install "boxsdk>=10"` | |
75 | | -| App using both [box-sdk-gen](https://pypi.org/project/box-sdk-gen/) and [boxsdk](https://pypi.org/project/boxsdk/) artifacts | Upgrade to [v4](https://github.com/box/box-python-sdk/tree/combined-sdk) | `pip install "boxsdk~=4.0"` | |
| 91 | +| App using both [box-sdk-gen](https://pypi.org/project/box-sdk-gen/) and [boxsdk](https://pypi.org/project/boxsdk/) artifacts | Upgrade to [v4](https://github.com/box/box-python-sdk/tree/combined-sdk) | `pip install "boxsdk~=4.0"` | |
76 | 92 | | App using v3 of [boxsdk](https://pypi.org/project/boxsdk/) artifact | Upgrade to [v4](https://github.com/box/box-python-sdk/tree/combined-sdk) | `pip install "boxsdk~=4.0"` | |
77 | 93 |
|
78 | 94 | For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/). |
@@ -233,16 +249,16 @@ back to you. If you have general questions about the Box API, you can post to th |
233 | 249 |
|
234 | 250 | # Copyright and License |
235 | 251 |
|
236 | | - Copyright 2019 Box, Inc. All rights reserved. |
| 252 | +Copyright 2025 Box, Inc. All rights reserved. |
237 | 253 |
|
238 | | - Licensed under the Apache License, Version 2.0 (the "License"); |
239 | | - you may not use this file except in compliance with the License. |
240 | | - You may obtain a copy of the License at |
| 254 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 255 | +you may not use this file except in compliance with the License. |
| 256 | +You may obtain a copy of the License at |
241 | 257 |
|
242 | | - http://www.apache.org/licenses/LICENSE-2.0 |
| 258 | + http://www.apache.org/licenses/LICENSE-2.0 |
243 | 259 |
|
244 | | - Unless required by applicable law or agreed to in writing, software |
245 | | - distributed under the License is distributed on an "AS IS" BASIS, |
246 | | - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
247 | | - See the License for the specific language governing permissions and |
248 | | - limitations under the License. |
| 260 | +Unless required by applicable law or agreed to in writing, software |
| 261 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 262 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 263 | +See the License for the specific language governing permissions and |
| 264 | +limitations under the License. |
0 commit comments