Skip to content

Commit 4073e38

Browse files
authored
Add info on installing with CRT support (#2812)
* Add info about CRT support This update adds a new section to the Quickstart article, "Using the AWS Common Runtime (CRT)". This section covers (briefly) what CRT is and why it matters, then what it's currently used for, plus how to install and remove CRT support from a project.
1 parent 7ed025e commit 4073e38

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

‎docs/source/guide/quickstart.rst‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,37 @@ certain versions, you may provide constraints when installing::
5656

5757
The latest development version of Boto3 is on `GitHub <https://github.com/boto/boto3>`_.
5858

59+
Using the AWS Common Runtime (CRT)
60+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
61+
62+
In addition to the default install of Boto3, you can choose to include the new `AWS Common Runtime <https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html>`_
63+
(CRT). The AWS CRT is a collection of modular packages that serve as a new foundation for AWS SDKs.
64+
Each library provides better performance and minimal footprint for the functional area it
65+
implements. Using the CRT, SDKs can share the same base code when possible, improving consistency
66+
and throughput optimizations across AWS SDKs.
67+
68+
When the AWS CRT is included, Boto3 uses it to incorporate features not otherwise
69+
available in the AWS SDK for Python.
70+
71+
At this time, Boto3 uses the AWS CRT's authentication package (`aws-c-auth
72+
<https://github.com/awslabs/aws-c-auth>`_) to add support for the `AWS Signature Version 4
73+
<https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html>`_ (sigv4) signer, which
74+
adds authentication to your AWS requests using your security credentials (your AWS access key and
75+
secret access key).
76+
77+
Boto3 doesn't use the AWS CRT by default but you can opt into using it by specifying the
78+
:code:`crt` `extra feature <https://www.python.org/dev/peps/pep-0508/#extras>`_ when installing Boto3::
79+
80+
pip install boto3[crt]
81+
82+
To revert to the non-CRT version of Boto3, use this command::
83+
84+
pip uninstall awscrt
85+
86+
If you need to re-enable CRT, reinstall :code:`boto3[crt]` to ensure you get a compatible version of :code:`awscrt`::
87+
88+
pip install boto3[crt]
89+
5990
Configuration
6091
-------------
6192

0 commit comments

Comments
 (0)