METADATA 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. Metadata-Version: 2.1
  2. Name: boto3
  3. Version: 1.29.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 :: Only
  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. Classifier: Programming Language :: Python :: 3.11
  23. Classifier: Programming Language :: Python :: 3.12
  24. Requires-Python: >= 3.7
  25. License-File: LICENSE
  26. License-File: NOTICE
  27. Requires-Dist: botocore (<1.33.0,>=1.32.6)
  28. Requires-Dist: jmespath (<2.0.0,>=0.7.1)
  29. Requires-Dist: s3transfer (<0.8.0,>=0.7.0)
  30. Provides-Extra: crt
  31. Requires-Dist: botocore[crt] (<2.0a0,>=1.21.0) ; extra == 'crt'
  32. ===============================
  33. Boto3 - The AWS SDK for Python
  34. ===============================
  35. |Version| |Python| |License|
  36. Boto3 is the Amazon Web Services (AWS) Software Development Kit (SDK) for
  37. Python, which allows Python developers to write software that makes use
  38. of services like Amazon S3 and Amazon EC2. You can find the latest, most
  39. up to date, documentation at our `doc site`_, including a list of
  40. services that are supported.
  41. Boto3 is maintained and published by `Amazon Web Services`_.
  42. 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.
  43. Notices
  44. -------
  45. On 2023-12-13, support for Python 3.7 will end for Boto3. This follows the
  46. Python Software Foundation `end of support <https://peps.python.org/pep-0537/#lifespan>`__
  47. for the runtime which occurred on 2023-06-27.
  48. For more information, see this `blog post <https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/>`__.
  49. .. _boto: https://docs.pythonboto.org/
  50. .. _`doc site`: https://boto3.amazonaws.com/v1/documentation/api/latest/index.html
  51. .. _`Amazon Web Services`: https://aws.amazon.com/what-is-aws/
  52. .. |Python| image:: https://img.shields.io/pypi/pyversions/boto3.svg?style=flat
  53. :target: https://pypi.python.org/pypi/boto3/
  54. :alt: Python Versions
  55. .. |Version| image:: http://img.shields.io/pypi/v/boto3.svg?style=flat
  56. :target: https://pypi.python.org/pypi/boto3/
  57. :alt: Package Version
  58. .. |License| image:: http://img.shields.io/pypi/l/boto3.svg?style=flat
  59. :target: https://github.com/boto/boto3/blob/develop/LICENSE
  60. :alt: License
  61. Getting Started
  62. ---------------
  63. Assuming that you have a supported version of Python installed, you can first
  64. set up your environment with:
  65. .. code-block:: sh
  66. $ python -m venv .venv
  67. ...
  68. $ . .venv/bin/activate
  69. Then, you can install boto3 from PyPI with:
  70. .. code-block:: sh
  71. $ python -m pip install boto3
  72. or install from source with:
  73. .. code-block:: sh
  74. $ git clone https://github.com/boto/boto3.git
  75. $ cd boto3
  76. $ python -m pip install -r requirements.txt
  77. $ python -m pip install -e .
  78. Using Boto3
  79. ~~~~~~~~~~~~~~
  80. After installing boto3
  81. Next, set up credentials (in e.g. ``~/.aws/credentials``):
  82. .. code-block:: ini
  83. [default]
  84. aws_access_key_id = YOUR_KEY
  85. aws_secret_access_key = YOUR_SECRET
  86. Then, set up a default region (in e.g. ``~/.aws/config``):
  87. .. code-block:: ini
  88. [default]
  89. region=us-east-1
  90. Other credential configuration methods can be found `here <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html>`__
  91. Then, from a Python interpreter:
  92. .. code-block:: python
  93. >>> import boto3
  94. >>> s3 = boto3.resource('s3')
  95. >>> for bucket in s3.buckets.all():
  96. print(bucket.name)
  97. Running Tests
  98. ~~~~~~~~~~~~~
  99. You can run tests in all supported Python versions using ``tox``. By default,
  100. it will run all of the unit and functional tests, but you can also specify your own
  101. ``pytest`` options. Note that this requires that you have all supported
  102. versions of Python installed, otherwise you must pass ``-e`` or run the
  103. ``pytest`` command directly:
  104. .. code-block:: sh
  105. $ tox
  106. $ tox -- unit/test_session.py
  107. $ tox -e py26,py33 -- integration/
  108. You can also run individual tests with your default Python version:
  109. .. code-block:: sh
  110. $ pytest tests/unit
  111. Getting Help
  112. ------------
  113. We use GitHub issues for tracking bugs and feature requests and have limited
  114. bandwidth to address them. Please use these community resources for getting
  115. help:
  116. * Ask a question on `Stack Overflow <https://stackoverflow.com/>`__ and tag it with `boto3 <https://stackoverflow.com/questions/tagged/boto3>`__
  117. * Open a support ticket with `AWS Support <https://console.aws.amazon.com/support/home#/>`__
  118. * If it turns out that you may have found a bug, please `open an issue <https://github.com/boto/boto3/issues/new>`__
  119. Contributing
  120. ------------
  121. 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.
  122. Maintenance and Support for SDK Major Versions
  123. ----------------------------------------------
  124. Boto3 was made generally available on 06/22/2015 and is currently in the full support phase of the availability life cycle.
  125. 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:
  126. * `AWS SDKs and Tools Maintenance Policy <https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html>`__
  127. * `AWS SDKs and Tools Version Support Matrix <https://docs.aws.amazon.com/sdkref/latest/guide/version-support-matrix.html>`__
  128. More Resources
  129. --------------
  130. * `NOTICE <https://github.com/boto/boto3/blob/develop/NOTICE>`__
  131. * `Changelog <https://github.com/boto/boto3/blob/develop/CHANGELOG.rst>`__
  132. * `License <https://github.com/boto/boto3/blob/develop/LICENSE>`__