Skip to content

Commit

Permalink
Merge branch 'release-1.16.56'
Browse files Browse the repository at this point in the history
* release-1.16.56:
  Bumping version to 1.16.56
  Add changelog entries from botocore
  Python2.7 deprecation (#2726)
  • Loading branch information
aws-sdk-python-automation committed Jan 15, 2021
2 parents cd34d6a + 7aa48b7 commit 60129f4
Show file tree
Hide file tree
Showing 10 changed files with 96 additions and 13 deletions.
7 changes: 7 additions & 0 deletions .changes/1.16.56.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[
{
"category": "``sns``",
"description": "[``botocore``] Update sns client to latest version",
"type": "api-change"
}
]
6 changes: 6 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
CHANGELOG
=========

1.16.56
=======

* api-change:``sns``: [``botocore``] Update sns client to latest version


1.16.55
=======

Expand Down
2 changes: 1 addition & 1 deletion boto3/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


__author__ = 'Amazon Web Services'
__version__ = '1.16.55'
__version__ = '1.16.56'


# The default Boto3 session; autoloaded when needed.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@

# General information about the project.
project = 'Boto3 Docs'
copyright = '2020, Amazon Web Services, Inc'
copyright = '2021, Amazon Web Services, Inc'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down
7 changes: 4 additions & 3 deletions docs/source/guide/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright 2010-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
.. Copyright 2010-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
International License (the "License"). You may not use this file except in compliance with the
Expand All @@ -10,9 +10,9 @@
.. _user_guides:

+++++++++++
+++++++++++++++
Developer guide
+++++++++++
+++++++++++++++


SDK features
Expand Down Expand Up @@ -51,4 +51,5 @@ Migrations

new
migration
migrationpy3
upgrading
2 changes: 1 addition & 1 deletion docs/source/guide/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Second, while every service now uses the runtime-generated low-level client, som
boto3_bucket = s3.Bucket('mybucket')

Installation and configuration
----------------------------
------------------------------
The :ref:`guide_quickstart` guide provides instructions for installing Boto3. You can also follow the instructions there to set up new credential files, or you can continue to use your existing Boto 2.x credentials. Please note that Boto3, the AWS CLI, and several other SDKs all use the shared credentials file (usually at ``~/.aws/credentials``).

Once configured, you may begin using Boto3::
Expand Down
55 changes: 55 additions & 0 deletions docs/source/guide/migrationpy3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
.. _guide_migration_py3:

Migrating from Python 2.7 to Python 3
=====================================
Python 2.7 was deprecated by the `Python Software Foundation <https://www.python.org/psf-landing/>`_ back on January 1, 2020 following a multi-year process of phasing it out. Because of this, AWS has deprecated support for Python 2.7, so versions of boto3 and botocore released after the deprecation date will no longer work with Python 2.7.

Timeline
--------
Going forward, all projects using the AWS SDK for Python need to transition to using Python 3, with Python 3.6 becoming the minimum by the end of the transition. The deprecation dates for the affected versions of Python are:

================== ===================
Python version Deprecation date
================== ===================
Python 2.7 July 15, 2021
Python 3.4 and 3.5 February 1, 2021
================== ===================

As shown in the table, Python 2.7 projects must transition to Python 3.6 by July 15, 2021, while Python 3.4 and 3.5 projects need to be updated to Python 3.6 by February 1, 2021.

Updating your project to use Python 3
-------------------------------------
Before you begin to update your project and environment, make sure you’ve installed or updated to Python 3.6 or later as described in :ref:`upgrade to Python 3 <quickstart_install_python>`. You can get Python from the `PSF web site <https://www.python.org/downloads>`_ or using your local package manager.

Update boto3 and botocore
~~~~~~~~~~~~~~~~~~~~~~~~~
Once you're sure you have Python 3 installed, you can proceed to upgrade boto3 and botocore. You can do this globally, or within your virtual environment if you use one for your project.

1. Begin by uninstalling the currently installed copies of boto3 and botocore::

$ python -m pip uninstall boto3 botocore

2. Then install the new version of boto3. This will also install botocore, which it requires::

$ python3 -m pip install boto3

3. You can optionally verify that the freshly installed copy of Boto3 is using the correct version of Python. One way to do that is to run a snippet of code that uses boto3 and outputs the Python and boto3 versions, such as the following::

$ python3 -c "import boto3, sys; print(f'{sys.version} \nboto3: {boto3.__version__}')"
3.8.6 (default, Jan 7 2021, 17:11:21)
[GCC 7.3.1 20180712 (Red Hat 7.3.1-11)]
boto3: 1.16.15

If you're unable to upgrade to Python 3
---------------------------------------
It may be possible that you're unable to upgrade to Python 3. If you have a large project that's heavily dependent on syntax or features that no longer work as desired in Python 3, for example, you may need to keep using Python 2.7. It's also possible that you need to postpone the Python transition while you finish updates to your code.

Under these circumstances, you should be prepared for the deprecation date in order to not be inconvenienced when the time arrives. If you've kept all software up-to-date, you shouldn't need to do anything. If you're using an existing installation of boto3 on Python 2, you can keep using it even after the deprecation date. That version of boto3, however, will not receive further feature or security updates, so you should consider migrating to Python 3 as soon as possible.

pip-based installations
~~~~~~~~~~~~~~~~~~~~~~~
If you installed boto3 using :command:`pip` 10.0 or later, you'll automatically stop receiving boto3 updates after the last Python 2 compatible version of boto3 is installed. If you're using an older version of :command:`pip`, you need to pin your boto3 install to no later than version 1.17.

Other installation methods
~~~~~~~~~~~~~~~~~~~~~~~~~~
If install boto3 from source or using any other approach, be sure you download and install a version released prior to the Python 2.7 deprecation date.
24 changes: 19 additions & 5 deletions docs/source/guide/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,24 @@ Getting started with Boto3 is easy, but requires a few steps.

Installation
------------
Prior to using Boto3, you need to install it and its dependencies.

.. _quickstart_install_python:

Install or update Python
~~~~~~~~~~~~~~~~~~~~~~~~
Before installing Boto3, ensure that you're using an up-to-date version of
Python. Unless you have specific reasons to use another version of Python, you
should be using Python 3.7 or later. Boto3 support for Python 2.7 is
deprecated and will end effective July 15, 2021. See :ref:`guide_migration_py3`
for more details, including timeline information and guidance regarding how to
transition to Python 3 if you haven't done so yet.

For more information on how to get the latest version of Python, please refer
to the official `Python documentation <https://www.python.org/downloads/>`_.

Install Boto3
~~~~~~~~~~~~~
Install the latest Boto3 release via :command:`pip`::

pip install boto3
Expand All @@ -16,13 +34,9 @@ You may also install a specific version::

.. note::

The latest development version can always be found on
The latest development version of Boto3 can always be found on
`GitHub <https://github.com/boto/boto3>`_.

.. note::

For best results, please ensure your version of Python is up-to-date. For more information on how to get the latest version of Python, please refer to the official `Python documentation <https://www.python.org/downloads/>`_.

Configuration
-------------
Before you can begin using Boto3, you should set up authentication
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ universal = 1

[metadata]
requires-dist =
botocore>=1.19.55,<1.20.0
botocore>=1.19.56,<1.20.0
jmespath>=0.7.1,<1.0.0
s3transfer>=0.3.0,<0.4.0
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


requires = [
'botocore>=1.19.55,<1.20.0',
'botocore>=1.19.56,<1.20.0',
'jmespath>=0.7.1,<1.0.0',
's3transfer>=0.3.0,<0.4.0'
]
Expand Down

0 comments on commit 60129f4

Please sign in to comment.