Skip to content

Commit 6203606

Browse files
authored
feat: Transition to stable status (#872)
1 parent 8c5e0ec commit 6203606

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,17 @@
22
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
33
</p>
44

5+
# Deprecation notice
6+
7+
This version of the Box Python SDK is under maintenance mode, and will be deprecated soon, only critical security updates and bug fixes will be provided. We recommend using the new version Box Python SDK, which can be found at [box/box-python-sdk-gen](https://github.com/box/box-python-sdk-gen)
8+
9+
You can find the migration guide [here](https://github.com/box/box-python-sdk-gen/blob/main/migration-guide.md) for transitioning from Box Python SDK v3.x to the new `box-sdk-gen` package. If you have any questions, please create an issue in the new repository or reach out to [Box Developer Support](https://developer.box.com/support/).
10+
511
# Box Python SDK
612

7-
[![image](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
13+
[![image](http://opensource.box.com/badges/stable.svg)](http://opensource.box.com/badges)
814
[![Documentation Status](https://readthedocs.org/projects/box-python-sdk/badge/?version=latest)](http://box-python-sdk.readthedocs.org/en/latest)
9-
[![image](https://github.com/box/box-python-sdk/workflows/build/badge.svg)](https://github.com/box/box-python-sdk/actions)
15+
[![image](https://github.com/box/box-python-sdk/actions/workflows/build.yml/badge.svg)](https://github.com/box/box-python-sdk/actions)
1016
[![image](https://img.shields.io/pypi/v/boxsdk.svg)](https://pypi.python.org/pypi/boxsdk)
1117
[![image](https://img.shields.io/pypi/dm/boxsdk.svg)](https://pypi.python.org/pypi/boxsdk)
1218
[![image](https://coveralls.io/repos/github/box/box-python-sdk/badge.svg?branch=main)](https://coveralls.io/github/box/box-python-sdk?branch=main)

boxsdk/client/client.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
import json
33
from datetime import datetime
44
from typing import TYPE_CHECKING, Optional, Iterable, Union, Any, IO
5+
from warnings import warn
56

67
from ..auth.oauth2 import TokenResponse
78
from ..session.session import Session, AuthorizedSession
@@ -74,6 +75,7 @@ def __init__(self, oauth: 'OAuth2', session: Session = None):
7475
The session object to use. If None is provided then an instance of :class:`AuthorizedSession` will be used.
7576
"""
7677
super().__init__()
78+
warn('Package \'boxsdk\' is going to be deprecated soon. Please use \'box-sdk-gen\' instead.', DeprecationWarning)
7779
self._oauth = oauth
7880
if session is not None:
7981
self._session = session

0 commit comments

Comments
 (0)