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
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`|
We are excited to introduce the stable release of the latest generation of Box Python SDK,
14
+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
15
+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
16
+
17
+
-[Introduction](#introduction)
18
+
-[Supported versions](#supported-versions)
19
+
-[Version v4](#version-v4)
20
+
-[Version v10](#version-v10)
21
+
-[Which Version Should I Use?](#which-version-should-i-use)
22
+
-[Installing](#installing)
23
+
-[Getting Started](#getting-started)
24
+
-[Authentication](#authentication)
25
+
-[Documentation](#documentation)
26
+
-[Migration guides](#migration-guides)
27
+
-[Versioning](#versioning)
28
+
-[Version schedule](#version-schedule)
29
+
-[Contributing](#contributing)
30
+
-[FIPS 140-2 Compliance](#fips-140-2-compliance)
31
+
-[Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
32
+
-[Copyright and License](#copyright-and-license)
33
+
34
+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
35
+
36
+
# Introduction
37
+
38
+
We are excited to introduce the v10 major release of the Box Python SDK,
37
39
designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
38
40
39
-
With this SDK, you’ll have access to:
41
+
With this SDK version, we provide the `box_sdk_gen` package, which gives you access to:
40
42
41
43
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.
42
44
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.
@@ -46,26 +48,44 @@ With this SDK, you’ll have access to:
46
48
47
49
Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.
48
50
49
-
# Table of contents
51
+
# Supported versions
50
52
51
-
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
52
-
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
53
+
To enhance developer experience, we have introduced the new generated codebase through the `box_sdk_gen` package.
54
+
The `box_sdk_gen` package is available in two major supported versions: v4 and v10.
-[Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
66
-
-[Copyright and License](#copyright-and-license)
56
+
## Version v4
67
57
68
-
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
58
+
In v4 of the Box Python SDK, we are introducing a version that consolidates both the manually written package (`boxsdk`)
59
+
and the new generated package (`box_sdk_gen`). This allows developers to use both packages simultaneously within a single project.
60
+
61
+
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.
62
+
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).
63
+
64
+
Version v4 is intended for:
65
+
66
+
- Existing developers of the Box Python SDK v3 who want to access new API features while keeping their current codebase largely unchanged.
67
+
- Existing developers who are in the process of migrating to `box_sdk_gen`, but do not want to move all their code to the new package immediately.
68
+
69
+
## Version v10
70
+
71
+
Starting with v10, the SDK is built entirely on the generated `box_sdk_gen` package, which fully and exclusively replaces the old `boxsdk` package.
72
+
The codebase for v10 of the Box Python SDK is currently available on the [sdk-gen](https://github.com/box/box-python-sdk/tree/sdk-gen) branch.
73
+
74
+
Version v10 is intended for:
75
+
76
+
- New users of the Box Python SDK.
77
+
- 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).
78
+
79
+
## Which Version Should I Use?
80
+
81
+
| 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"`|
84
+
| 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"`|
85
+
| 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"`|
86
+
| 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"`|
87
+
88
+
For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/).
Browse the [docs](docs/README.md) or see [API Reference](https://developer.box.com/reference/) for more information.
113
141
114
-
# Upgrades
142
+
# Migration guides
143
+
144
+
Migration guides which help you to migrate to supported major SDK versions can be found [here](./migration-guides).
115
145
116
-
The SDK is updated regularly to include new features, enhancements, and bug fixes.
117
-
If you are upgrading from manual v3 SDK version to this new generated v10, checkout the [migration guide](migration-guides/from-v3-to-v10.md) and [changelog](CHANGELOG.md) for more information.
146
+
# Versioning
118
147
119
-
# Integration Tests
148
+
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.
120
149
121
-
## Running integration tests locally
150
+
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.
151
+
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).
152
+
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.
122
153
123
-
### Create Platform Application
154
+
We always recommend that all users run the latest available minor release for whatever major version is in use.
155
+
We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.
124
156
125
-
To run integration tests locally you will need a `Custom App` created in the [Box Developer
126
-
Console](https://app.box.com/developers/console)
127
-
with `Server Authentication (with JWT)` selected as authentication method.
128
-
Once created you can edit properties of the application:
157
+
## Version schedule
129
158
130
-
- In section `App Access Level` select `App + Enterprise Access`. You can enable all `Application Scopes`.
131
-
- In section `Advanced Features` enable `Make API calls using the as-user header` and `Generate user access tokens`.
159
+
| Version | Supported Environments | State | First Release | EOL/Terminated |
| 4 | Python 3.8+ | Supported | 23 Oct 2025 | 2027 or v5 is released |
163
+
| 3 | Python 3.6+ | EOL | 17 Jan 2022 | 23 Oct 2025 |
164
+
| 2 || EOL | 01 Nov 2018 | 17 Jan 2022 |
165
+
| 1 || EOL | 10 Feb 2015 | 01 Nov 2018 |
132
166
133
-
Now select `Authorization` and submit application to be reviewed by account admin.
167
+
# Contributing
134
168
135
-
### Export configuration
169
+
See [CONTRIBUTING.md](./CONTRIBUTING.md).
136
170
137
-
1. Select `Configuration` tab and in the bottom in the section `App Settings`
138
-
download your app configuration settings as JSON.
139
-
2. Encode configuration file to Base64, e.g. using command: `base64 -i path_to_json_file`
140
-
3. Set environment variable: `JWT_CONFIG_BASE_64` with base64 encoded jwt configuration file
141
-
4. Set environment variable: `BOX_FILE_REQUEST_ID` with ID of file request already created in the user account, `BOX_EXTERNAL_USER_EMAIL` with email of free external user which not belongs to any enterprise and `BOX_EXTERNAL_USER_ID` with its ID.
142
-
5. Set environment variable: `WORKFLOW_FOLDER_ID` with the ID of the Relay workflow that deletes the file that triggered the workflow. The workflow should have a manual start to be able to start it from the API.
143
-
6. Set environment variable: `APP_ITEM_ASSOCIATION_FILE_ID` to the ID of the file with associated app item and `APP_ITEM_ASSOCIATION_FOLDER_ID` to the ID of the folder with associated app item.
144
-
7. Set environment variable: `APP_ITEM_SHARED_LINK` to the shared link associated with app item.
145
-
8. Set environment variable: `SLACK_AUTOMATION_USER_ID` to the ID of the user responsible for the Slack automation, `SLACK_ORG_ID` to the ID of the Slack organization and `SLACK_PARTNER_ITEM_ID` to the ID of the Slack partner item.
171
+
# FIPS 140-2 Compliance
146
172
147
-
### Running tests
173
+
The Python SDK allows the use of FIPS 140-2 validated SSL libraries, such as OpenSSL 3.0.
174
+
However, some actions are required to enable this functionality.
148
175
149
-
To run integration tests locally:
176
+
Currently, the latest distributions of Python default to OpenSSL v1.1.1, which is not FIPS compliant.
177
+
Therefore, if you want to use OpenSSL 3.0 in your network communication,
178
+
you need to ensure that Python uses a custom SSL library.
179
+
One way to achieve this is by creating a custom Python distribution with the ssl module replaced.
150
180
151
-
1.`pip install -r requirements-test.txt`
152
-
2.`pytest`
181
+
If you are using JWT for authentication, it is also necessary to ensure that the cryptography library,
182
+
which is one of the extra dependencies for JWT, uses OpenSSL 3.0.
183
+
To enable FIPS mode for the `cryptography` library, you need to install a FIPS-compliant version of OpenSSL
184
+
during the installation process of cryptography using the `pip` command.
153
185
154
186
# Questions, Bugs, and Feature Requests?
155
187
156
-
Need to contact us directly? [Browse the issues
157
-
tickets](https://github.com/box/box-python-sdk/issues)! Or, if that
158
-
doesn't work, [file a new
159
-
one](https://github.com/box/box-python-sdk/issues/new) and we will get
160
-
back to you. If you have general questions about the Box API, you can
161
-
post to the [Box Developer Forum](https://forum.box.com/).
188
+
Need to contact us directly? [Browse the issues tickets](https://github.com/box/box-python-sdk/issues)! Or, if that
189
+
doesn't work, [file a new one](https://github.com/box/box-python-sdk/issues/new) and we will get
190
+
back to you. If you have general questions about the Box API, you can post to the [Box Developer Forum](https://community.box.com/box-platform-5).
162
191
163
192
# Copyright and License
164
193
165
-
Copyright 2023 Box, Inc. All rights reserved.
194
+
Copyright 2025 Box, Inc. All rights reserved.
166
195
167
196
Licensed under the Apache License, Version 2.0 (the "License");
168
197
you may not use this file except in compliance with the License.
0 commit comments