METADATA 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  1. Metadata-Version: 2.1
  2. Name: boto3
  3. Version: 1.23.6
  4. Summary: The AWS SDK for Python
  5. Home-page: https://github.com/boto/boto3
  6. Author: Amazon Web Services
  7. License: Apache License 2.0
  8. Project-URL: Documentation, https://boto3.amazonaws.com/v1/documentation/api/latest/index.html
  9. Project-URL: Source, https://github.com/boto/boto3
  10. Platform: UNKNOWN
  11. Classifier: Development Status :: 5 - Production/Stable
  12. Classifier: Intended Audience :: Developers
  13. Classifier: Natural Language :: English
  14. Classifier: License :: OSI Approved :: Apache Software License
  15. Classifier: Programming Language :: Python
  16. Classifier: Programming Language :: Python :: 3
  17. Classifier: Programming Language :: Python :: 3.6
  18. Classifier: Programming Language :: Python :: 3.7
  19. Classifier: Programming Language :: Python :: 3.8
  20. Classifier: Programming Language :: Python :: 3.9
  21. Classifier: Programming Language :: Python :: 3.10
  22. Requires-Python: >= 3.6
  23. License-File: LICENSE
  24. License-File: NOTICE
  25. Requires-Dist: botocore (<1.27.0,>=1.26.6)
  26. Requires-Dist: jmespath (<2.0.0,>=0.7.1)
  27. Requires-Dist: s3transfer (<0.6.0,>=0.5.0)
  28. Provides-Extra: crt
  29. Requires-Dist: botocore[crt] (<2.0a0,>=1.21.0) ; extra == 'crt'
  30. ===============================
  31. Boto3 - The AWS SDK for Python
  32. ===============================
  33. |Version| |Python| |License|
  34. Boto3 is the Amazon Web Services (AWS) Software Development Kit (SDK) for
  35. Python, which allows Python developers to write software that makes use
  36. of services like Amazon S3 and Amazon EC2. You can find the latest, most
  37. up to date, documentation at our `doc site`_, including a list of
  38. services that are supported.
  39. Boto3 is maintained and published by `Amazon Web Services`_.
  40. Boto (pronounced boh-toh) was named after the fresh water dolphin native to the Amazon river. The name was chosen by the author of the original Boto library, Mitch Garnaat, as a reference to the company.
  41. Notices
  42. -------
  43. On 2021-01-15, deprecation for Python 2.7 was announced and support was dropped
  44. on 2021-07-15. To avoid disruption, customers using Boto3 on Python 2.7 may
  45. need to upgrade their version of Python or pin the version of Boto3. For
  46. more information, see this `blog post <https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-python-2-7-in-aws-sdk-for-python-and-aws-cli-v1/>`__.
  47. On 2022-05-30, we will be dropping support for Python 3.6. This follows the
  48. Python Software Foundation `end of support <https://www.python.org/dev/peps/pep-0494/#lifespan>`__
  49. for the runtime which occurred on 2021-12-23.
  50. For more information, see this `blog post <https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/>`__.
  51. .. _boto: https://docs.pythonboto.org/
  52. .. _`doc site`: https://boto3.amazonaws.com/v1/documentation/api/latest/index.html
  53. .. _`Amazon Web Services`: https://aws.amazon.com/what-is-aws/
  54. .. |Python| image:: https://img.shields.io/pypi/pyversions/boto3.svg?style=flat
  55. :target: https://pypi.python.org/pypi/boto3/
  56. :alt: Python Versions
  57. .. |Version| image:: http://img.shields.io/pypi/v/boto3.svg?style=flat
  58. :target: https://pypi.python.org/pypi/boto3/
  59. :alt: Package Version
  60. .. |License| image:: http://img.shields.io/pypi/l/boto3.svg?style=flat
  61. :target: https://github.com/boto/boto3/blob/develop/LICENSE
  62. :alt: License
  63. Getting Started
  64. ---------------
  65. Assuming that you have a supported version of Python installed, you can first
  66. set up your environment with:
  67. .. code-block:: sh
  68. $ python -m venv .venv
  69. ...
  70. $ . .venv/bin/activate
  71. Then, you can install boto3 from PyPI with:
  72. .. code-block:: sh
  73. $ python -m pip install boto3
  74. or install from source with:
  75. .. code-block:: sh
  76. $ git clone https://github.com/boto/boto3.git
  77. $ cd boto3
  78. $ python -m pip install -r requirements.txt
  79. $ python -m pip install -e .
  80. Using Boto3
  81. ~~~~~~~~~~~~~~
  82. After installing boto3
  83. Next, set up credentials (in e.g. ``~/.aws/credentials``):
  84. .. code-block:: ini
  85. [default]
  86. aws_access_key_id = YOUR_KEY
  87. aws_secret_access_key = YOUR_SECRET
  88. Then, set up a default region (in e.g. ``~/.aws/config``):
  89. .. code-block:: ini
  90. [default]
  91. region=us-east-1
  92. Other credentials configuration method can be found `here <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html>`__
  93. Then, from a Python interpreter:
  94. .. code-block:: python
  95. >>> import boto3
  96. >>> s3 = boto3.resource('s3')
  97. >>> for bucket in s3.buckets.all():
  98. print(bucket.name)
  99. Running Tests
  100. ~~~~~~~~~~~~~
  101. You can run tests in all supported Python versions using ``tox``. By default,
  102. it will run all of the unit and functional tests, but you can also specify your own
  103. ``pytest`` options. Note that this requires that you have all supported
  104. versions of Python installed, otherwise you must pass ``-e`` or run the
  105. ``pytest`` command directly:
  106. .. code-block:: sh
  107. $ tox
  108. $ tox -- unit/test_session.py
  109. $ tox -e py26,py33 -- integration/
  110. You can also run individual tests with your default Python version:
  111. .. code-block:: sh
  112. $ pytest tests/unit
  113. Getting Help
  114. ------------
  115. We use GitHub issues for tracking bugs and feature requests and have limited
  116. bandwidth to address them. Please use these community resources for getting
  117. help:
  118. * Ask a question on `Stack Overflow <https://stackoverflow.com/>`__ and tag it with `boto3 <https://stackoverflow.com/questions/tagged/boto3>`__
  119. * Open a support ticket with `AWS Support <https://console.aws.amazon.com/support/home#/>`__
  120. * If it turns out that you may have found a bug, please `open an issue <https://github.com/boto/boto3/issues/new>`__
  121. Contributing
  122. ------------
  123. We value feedback and contributions from our community. Whether it's a bug report, new feature, correction, or additional documentation, we welcome your issues and pull requests. Please read through this `CONTRIBUTING <https://github.com/boto/boto3/blob/develop/CONTRIBUTING.rst>`__ document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your contribution.
  124. Maintenance and Support for SDK Major Versions
  125. ----------------------------------------------
  126. Boto3 was made generally available on 06/22/2015 and is currently in the full support phase of the availability life cycle.
  127. For information about maintenance and support for SDK major versions and their underlying dependencies, see the following in the AWS SDKs and Tools Shared Configuration and Credentials Reference Guide:
  128. * `AWS SDKs and Tools Maintenance Policy <https://docs.aws.amazon.com/credref/latest/refdocs/maint-policy.html>`__
  129. * `AWS SDKs and Tools Version Support Matrix <https://docs.aws.amazon.com/credref/latest/refdocs/version-support-matrix.html>`__
  130. More Resources
  131. --------------
  132. * `NOTICE <https://github.com/boto/boto3/blob/develop/NOTICE>`__
  133. * `Changelog <https://github.com/boto/boto3/blob/develop/CHANGELOG.rst>`__
  134. * `License <https://github.com/boto/boto3/blob/develop/LICENSE>`__