Skip to content

Commit d94bb2a

Browse files
docs: Add migration guides (#1124)
1 parent e236877 commit d94bb2a

File tree

3 files changed

+797
-1
lines changed

3 files changed

+797
-1
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "48e5311", "specHash": "fa34496", "version": "0.1.0" }
1+
{ "engineHash": "fa0419f", "specHash": "fa34496", "version": "0.1.0" }
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Migration guide from v1 version of the `box-python-sdk-gen` to the v10 version of the `box-python-sdk`
2+
3+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
4+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
5+
6+
- [Installation](#installation)
7+
- [How to migrate](#how-to-migrate)
8+
9+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
10+
11+
## Installation
12+
13+
In order to start using v10 version of the Box Python SDK, you need to change the dependency in your project.
14+
The artifact name has changed from `box-sdk-gen` to `boxsdk`.
15+
You also need to set the version to `10.0.0` or higher. You can find the latest version on [PyPI](https://pypi.org/project/boxsdk/).
16+
17+
### How to migrate
18+
19+
To start using v10 version of Box Python SDK in you Maven project replace the dependency in your `requirements.txt`
20+
or installation command.
21+
22+
**Old (`box-python-sdk-gen-v1`)**
23+
24+
```console
25+
pip install box-sdk-gen
26+
```
27+
28+
**New (`box-python-sdk-v10`)**
29+
30+
```console
31+
pip install boxsdk>=10
32+
```

0 commit comments

Comments
 (0)