Box Python Generated SDK

Warnings

• breaking The standalone `box-sdk-gen` package is deprecated as of September 17, 2025. It will no longer receive new features, updates, bug fixes, or security patches. All future development is consolidated into the `boxsdk` package (version 10.0.0 and higher).
  Fix: Migrate your project to use `boxsdk` version 10.0.0 or higher. Install with `pip install boxsdk>=10`. The `box_sdk_gen` module will be available within the `boxsdk` package, so imports like `from box_sdk_gen import ...` will continue to work after migration.
• gotcha When upgrading to `boxsdk` v10+, significant interface changes may be present, especially for older `boxsdk` users. While `box_sdk_gen` retains its internal structure, the overarching `boxsdk` client instantiation and some method signatures may have been updated.
  Fix: Consult the Box SDK versioning strategy and migration guides for detailed instructions when moving to the consolidated `boxsdk` package. Thoroughly test your application after upgrading.
• gotcha Using a Developer Token is suitable only for testing and development. These tokens are short-lived and cannot be refreshed, making them unsuitable for production applications.
  Fix: For production, implement more secure and robust authentication methods such as OAuth 2.0, Client Credentials Grant (CCG), or JSON Web Token (JWT) as detailed in the official Box authentication documentation.
• gotcha Specific authentication classes (e.g., for JWT, CCG) are located in submodules like `box_sdk_gen.jwt_auth` or `box_sdk_gen.ccg_auth`, not directly under `box_sdk_gen`.
  Fix: Ensure correct import paths for authentication-related classes, e.g., `from box_sdk_gen.jwt_auth import BoxJWTAuth` or `from box_sdk_gen.ccg_auth import CCGConfig`.

Install

• pip install box-sdk-gen Direct installation (deprecated)
• pip install boxsdk>=10 Recommended: Consolidated SDK
• pip install "boxsdk[jwt]>=10" Recommended: Consolidated SDK with JWT support

Imports

• BoxClient

  from box_sdk_gen import BoxClient

• BoxDeveloperTokenAuth

  from box_sdk_gen import BoxDeveloperTokenAuth

• BoxJWTAuth

  from box_sdk_gen.jwt_auth import BoxJWTAuth

  JWT authentication classes are found in the `jwt_auth` submodule.
• CCGConfig

  from box_sdk_gen.ccg_auth import CCGConfig

  Client Credentials Grant configuration is in the `ccg_auth` submodule.

Quickstart

This quickstart demonstrates how to authenticate using a Developer Token and fetch information about the current user and list items in the root folder. For production environments, consider more robust authentication methods like OAuth 2.0 or JWT. The developer token should be obtained from your Box Developer Console.

import os
from box_sdk_gen import BoxClient, BoxDeveloperTokenAuth

# It's recommended to set your developer token as an environment variable
# For testing, you can replace os.environ.get with your actual token string
DEVELOPER_TOKEN = os.environ.get('BOX_DEVELOPER_TOKEN', 'YOUR_DEVELOPER_TOKEN')

if not DEVELOPER_TOKEN or DEVELOPER_TOKEN == 'YOUR_DEVELOPER_TOKEN':
    print("Please set the BOX_DEVELOPER_TOKEN environment variable or replace the placeholder.")
else:
    try:
        auth = BoxDeveloperTokenAuth(token=DEVELOPER_TOKEN)
        client = BoxClient(auth=auth)

        # Get information about the current user
        me = client.users.get_user_me()
        print(f"Hello, I'm {me.name} (ID: {me.id}) - Login: {me.login}")

        # List items in the root folder (ID '0')
        print("\nItems in your root folder:")
        root_folder_items = client.folders.get_folder_items('0').entries
        if root_folder_items:
            for item in root_folder_items:
                print(f"  - {item.type.value.capitalize()}: {item.name} (ID: {item.id})")
        else:
            print("  No items found in the root folder.")

    except Exception as e:
        print(f"An error occurred: {e}")
        print("Please ensure your developer token is valid and has the necessary permissions.")