Skip to content

Commit e230592

Browse files
committed
Add versioning note to README
1 parent 52253ff commit e230592

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.rst

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,34 @@ Installing
2828

2929
.. code-block:: console
3030
31-
pip install boxsdk
32-
31+
pip install "boxsdk>=1.5,<2.0"
32+
33+
Important Versioning Note
34+
-------------------------
35+
36+
The production version of the ``boxsdk`` package is the 1.5.x release track.
37+
The code can be found on Github at
38+
<https://github.com/box/box-python-sdk/tree/1.5>. This is what will be
39+
installed with ``pip install boxsdk``.
40+
41+
The development version of the ``boxsdk`` package is the 2.0.0 release track,
42+
currently in an alpha release. The code can be found on Github at
43+
<https://github.com/box/box-python-sdk/tree/master>. This isn't installed by
44+
``pip`` by default, but can be installed if specifying a specific version. For
45+
example, ``pip install boxsdk==2.0.0a5``. We welcome early testing and feedback
46+
on these alpha releases. Note that while we're still in alpha, version 2.0.0 is
47+
subject to change, and there might be breaking changes between alpha releases
48+
(e.g. between 2.0.0a2 and 2.0.0a3).
49+
50+
The 1.5.x release track will receive bugfix support at least until the final
51+
release of 2.0.0.
52+
53+
We always recommend pinning to a specific version (e.g. by adding
54+
``boxsdk==1.5.3`` in your ``requirements.txt`` file), so that you don't risk
55+
accidentally upgrading to a new version and breaking your application. This is
56+
particularly important with the upcoming 2.0.0 release. There will be some
57+
breaking changes in version 2.0.0, which might break your application if you
58+
upgrade without adapting your code first.
3359

3460
Authorization
3561
-------------

0 commit comments

Comments
 (0)