Skip to content

docs: Adjust README and migration guide for v10 (box/box-codegen#782) (box/box-codegen#785) #935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mwwoda merged 3 commits into from
Aug 14, 2025
Merged

docs: Adjust README and migration guide for v10 (box/box-codegen#782) (box/box-codegen#785) #935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f1fcba
chore: Update .codegen.json with commit hash of codegen and openapi spec
box-sdk-build Aug 13, 2025
613f0d9
chore: Update .codegen.json with commit hash of codegen and openapi spec
box-sdk-build Aug 13, 2025
42c742f
docs: Adjust Python `README` and migration guide for v10 (box/box-cod…
box-sdk-build Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "be39be6", "specHash": "24fbeb9", "version": "0.1.0" }
{ "engineHash": "1d94996", "specHash": "24fbeb9", "version": "0.1.0" }
31 changes: 17 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
</p>

# Box Python SDK Gen
# Box Python SDK

[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
![build](https://github.com/box/box-python-sdk-gen/actions/workflows/build.yml/badge.svg)
[![PyPI version](https://badge.fury.io/py/box-sdk-gen.svg)](https://badge.fury.io/py/box-sdk-gen)
[![image](https://img.shields.io/pypi/dm/box-sdk-gen.svg)](https://pypi.python.org/pypi/box-sdk-gen)
![build](https://github.com/box/box-python-sdk/actions/workflows/build.yml/badge.svg?branch=sdk-gen)
[![PyPI version](https://badge.fury.io/py/boxsdk.svg)](https://badge.fury.io/py/boxsdk)
[![image](https://img.shields.io/pypi/dm/boxsdk.svg)](https://pypi.python.org/pypi/boxsdk)
![Platform](https://img.shields.io/badge/python-3.8+-blue)
[![Coverage](https://coveralls.io/repos/github/box/box-python-sdk-gen/badge.svg?branch=main)](https://coveralls.io/github/box/box-python-sdk-gen?branch=main)
[![Coverage](https://coveralls.io/repos/github/box/box-python-sdk/badge.svg?branch=sdk-gen)](https://coveralls.io/github/box/box-python-sdk?branch=sdk-gen)

We are excited to introduce the stable release of the latest generation of Box Python SDK, designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
We are excited to introduce the stable release of the latest generation of Box Python SDK,
designed to elevate the developer experience and streamline your integration with the Box Content Cloud.

With this SDK, you’ll have access to:

Expand All @@ -28,7 +29,7 @@ Embrace the new generation of Box SDKs and unlock the full potential of the Box
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Box Python SDK Gen](#box-python-sdk-gen)
- [Box Python SDK](#box-python-sdk)
- [Table of contents](#table-of-contents)
- [Installing](#installing)
- [Getting Started](#getting-started)
Expand All @@ -46,17 +47,18 @@ Embrace the new generation of Box SDKs and unlock the full potential of the Box

# Installing

The next generation of the SDK starts with version `10.0.0`.

```console
pip install box-sdk-gen
pip install boxsdk>=10
```

This is autogenerated Box SDK version.
Supported Python versions are Python 3.8 and above.
This is autogenerated Box SDK version. Supported Python versions are Python 3.8 and above.

To install also extra dependencies required for JWT authentication, use command:

```console
pip install "box-sdk-gen[jwt]"
pip install "boxsdk[jwt]>=10"
```

# Getting Started
Expand Down Expand Up @@ -89,7 +91,8 @@ Browse the [docs](docs/README.md) or see [API Reference](https://developer.box.c

# Upgrades

Upgrading from our legacy SDKs to the new generation SDKs is a straightforward process. See our [migration guide](migration-guide.md) and [changelog](CHANGELOG.md) for more information.
The SDK is updated regularly to include new features, enhancements, and bug fixes.
If you are upgrading from manual v3 SDK version to this new generated v10, checkout the [migration guide](migration-guide.md) and [changelog](CHANGELOG.md) for more information.

# Integration Tests

Expand Down Expand Up @@ -129,9 +132,9 @@ To run integration tests locally:
# Questions, Bugs, and Feature Requests?

Need to contact us directly? [Browse the issues
tickets](https://github.com/box/box-python-sdk-gen/issues)! Or, if that
tickets](https://github.com/box/box-python-sdk/issues)! Or, if that
doesn't work, [file a new
one](https://github.com/box/box-python-sdk-gen/issues/new) and we will get
one](https://github.com/box/box-python-sdk/issues/new) and we will get
back to you. If you have general questions about the Box API, you can
post to the [Box Developer Forum](https://forum.box.com/).

Expand Down
Loading
Loading