{"id":13897472,"url":"https://github.com/box/box-python-sdk","last_synced_at":"2026-02-11T14:05:10.844Z","repository":{"id":26924202,"uuid":"30386388","full_name":"box/box-python-sdk","owner":"box","description":"Box SDK for Python","archived":false,"fork":false,"pushed_at":"2025-04-09T15:06:31.000Z","size":54998,"stargazers_count":427,"open_issues_count":23,"forks_count":216,"subscribers_count":36,"default_branch":"main","last_synced_at":"2025-04-10T22:17:53.960Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://opensource.box.com/box-python-sdk/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/box.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-02-06T00:30:55.000Z","updated_at":"2025-04-09T15:06:10.000Z","dependencies_parsed_at":"2023-01-14T05:37:28.793Z","dependency_job_id":"42b01d61-0fee-4183-a509-ac3be0797de0","html_url":"https://github.com/box/box-python-sdk","commit_stats":{"total_commits":543,"total_committers":70,"mean_commits":7.757142857142857,"dds":0.861878453038674,"last_synced_commit":"f351590add58075495f416fb1d09f4e4e6d3ef61"},"previous_names":[],"tags_count":84,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/box%2Fbox-python-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/box%2Fbox-python-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/box%2Fbox-python-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/box%2Fbox-python-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/box","download_url":"https://codeload.github.com/box/box-python-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253924032,"owners_count":21985027,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-06T18:03:37.225Z","updated_at":"2026-02-11T14:05:10.831Z","avatar_url":"https://github.com/box.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/box/sdks/blob/master/images/box-dev-logo.png\" alt= “box-dev-logo” width=\"30%\" height=\"50%\"\u003e\n\u003c/p\u003e\n\n# Box Python SDK v10\n\n[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)\n![build](https://github.com/box/box-python-sdk/actions/workflows/build.yml/badge.svg?branch=main)\n[![PyPI version](https://badge.fury.io/py/boxsdk.svg)](https://badge.fury.io/py/boxsdk)\n[![image](https://img.shields.io/pypi/dm/boxsdk.svg)](https://pypi.python.org/pypi/boxsdk)\n![Platform](https://img.shields.io/badge/python-3.8+-blue)\n[![Coverage](https://coveralls.io/repos/github/box/box-python-sdk/badge.svg?branch=main)](https://coveralls.io/github/box/box-python-sdk?branch=main)\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n- [Introduction](#introduction)\n- [Supported versions](#supported-versions)\n  - [Version v4](#version-v4)\n  - [Version v10](#version-v10)\n  - [Which Version Should I Use?](#which-version-should-i-use)\n- [Installing](#installing)\n- [Getting Started](#getting-started)\n- [Authentication](#authentication)\n- [Documentation](#documentation)\n- [Migration guides](#migration-guides)\n- [Versioning](#versioning)\n  - [Version schedule](#version-schedule)\n- [Contributing](#contributing)\n- [FIPS 140-2 Compliance](#fips-140-2-compliance)\n- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)\n- [Copyright and License](#copyright-and-license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n# Introduction\n\nWe are excited to introduce the v10 major release of the Box Python SDK,\ndesigned to elevate the developer experience and streamline your integration with the Box Content Cloud.\n\nWith this SDK version, we provide the `box_sdk_gen` package, which gives you access to:\n\n1. 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.\n2. 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.\n3. 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.\n4. 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.\n5. 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.\n\nEmbrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.\n\n# Supported versions\n\nTo enhance developer experience, we have introduced the new generated codebase through the `box_sdk_gen` package.\nThe `box_sdk_gen` package is available in two major supported versions: v4 and v10.\n\n## Version v4\n\nIn v4 of the Box Python SDK, we are introducing a version that consolidates both the manually written package (`boxsdk`)\nand the new generated package (`box_sdk_gen`). This allows developers to use both packages simultaneously within a single project.\n\nThe 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.\nMigration 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).\n\nVersion v4 is intended for:\n\n- Existing developers of the Box Python SDK v3 who want to access new API features while keeping their current codebase largely unchanged.\n- 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.\n\n## Version v10\n\nStarting with v10, the SDK is built entirely on the generated `box_sdk_gen` package, which fully and exclusively replaces the old `boxsdk` package.\nThe codebase for v10 of the Box Python SDK is currently available on the [main](https://github.com/box/box-python-sdk/tree/main) branch.\n\nVersion v10 is intended for:\n\n- New users of the Box Python SDK.\n- 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).\n\n## Which Version Should I Use?\n\n| Scenario                                                                                                                     | Recommended Version                                                      | Example `pip install`       |\n| ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | --------------------------- |\n| Creating a new application                                                                                                   | Use [v10](https://github.com/box/box-python-sdk/tree/main)               | `pip install \"boxsdk\u003e=10\"`  |\n| App using [box-sdk-gen](https://pypi.org/project/box-sdk-gen/) artifact                                                      | Migrate to [v10](https://github.com/box/box-python-sdk/tree/main)        | `pip install \"boxsdk\u003e=10\"`  |\n| 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\"` |\n| 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\"` |\n\nFor full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/).\n\n# Installing\n\nThe next generation of the SDK starts with version `10.0.0`.\n\n```console\npip install boxsdk\u003e=10\n```\n\nThis is autogenerated Box SDK version. Supported Python versions are Python 3.8 and above.\n\nTo install also extra dependencies required for JWT authentication, use command:\n\n```console\npip install \"boxsdk[jwt]\u003e=10\"\n```\n\n# Getting Started\n\nTo get started with the SDK, get a Developer Token from the Configuration page of your app in the [Box Developer\nConsole](https://app.box.com/developers/console). You can use this token to make test calls for your own Box account.\n\nThe SDK provides an `BoxDeveloperTokenAuth` class, which allows you to authenticate using your Developer Token.\nUse instance of `BoxDeveloperTokenAuth` to initialize `BoxClient` object.\nUsing `BoxClient` object you can access managers, which allow you to perform some operations on your Box account.\n\nThe example below demonstrates how to authenticate with Developer Token and print names of all items inside a root folder.\n\n```python\nfrom box_sdk_gen import BoxClient, BoxDeveloperTokenAuth\n\ndef main(token: str):\n    auth: BoxDeveloperTokenAuth = BoxDeveloperTokenAuth(token=token)\n    client: BoxClient = BoxClient(auth=auth)\n    for item in client.folders.get_folder_items('0').entries:\n        print(item.name)\n\nif __name__ == '__main__':\n    main('INSERT YOUR DEVELOPER TOKEN HERE')\n```\n\n# Authentication\n\nBox Python SDK v10 supports multiple authentication methods including Developer Token, OAuth 2.0,\nClient Credentials Grant, and JSON Web Token (JWT).\n\nYou can find detailed instructions and example code for each authentication method in\n[Authentication](./docs/authentication.md) document.\n\n# Documentation\n\nBrowse the [docs](docs/README.md) or see [API Reference](https://developer.box.com/reference/) for more information.\n\n# Migration guides\n\nMigration guides which help you to migrate to supported major SDK versions can be found [here](./migration-guides).\n\n# Versioning\n\nWe 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.\n\nA 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.  \nInstead 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).\nAt 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.\n\nWe always recommend that all users run the latest available minor release for whatever major version is in use.\nWe highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.\n\n## Version schedule\n\n| Version | Supported Environments | State     | First Release | EOL/Terminated         |\n| ------- | ---------------------- | --------- | ------------- | ---------------------- |\n| 10      | Python 3.8+            | Supported | 17 Sep 2025   | TBD                    |\n| 4       | Python 3.8+            | Supported | 23 Oct 2025   | 2027 or v5 is released |\n| 3       | Python 3.6+            | EOL       | 17 Jan 2022   | 23 Oct 2025            |\n| 2       |                        | EOL       | 01 Nov 2018   | 17 Jan 2022            |\n| 1       |                        | EOL       | 10 Feb 2015   | 01 Nov 2018            |\n\n# Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n# FIPS 140-2 Compliance\n\nThe Python SDK allows the use of FIPS 140-2 validated SSL libraries, such as OpenSSL 3.0.\nHowever, some actions are required to enable this functionality.\n\nCurrently, the latest distributions of Python default to OpenSSL v1.1.1, which is not FIPS compliant.\nTherefore, if you want to use OpenSSL 3.0 in your network communication,\nyou need to ensure that Python uses a custom SSL library.\nOne way to achieve this is by creating a custom Python distribution with the ssl module replaced.\n\nIf you are using JWT for authentication, it is also necessary to ensure that the cryptography library,\nwhich is one of the extra dependencies for JWT, uses OpenSSL 3.0.\nTo enable FIPS mode for the `cryptography` library, you need to install a FIPS-compliant version of OpenSSL\nduring the installation process of cryptography using the `pip` command.\n\n# Questions, Bugs, and Feature Requests?\n\nNeed to contact us directly? [Browse the issues tickets](https://github.com/box/box-python-sdk/issues)! Or, if that\ndoesn't work, [file a new one](https://github.com/box/box-python-sdk/issues/new) and we will get\nback 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).\n\n# Copyright and License\n\nCopyright 2025 Box, Inc. All rights reserved.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbox%2Fbox-python-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbox%2Fbox-python-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbox%2Fbox-python-sdk/lists"}