METADATA 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. Metadata-Version: 2.1
  2. Name: boto3
  3. Version: 1.17.112
  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. Platform: UNKNOWN
  9. Classifier: Development Status :: 5 - Production/Stable
  10. Classifier: Intended Audience :: Developers
  11. Classifier: Natural Language :: English
  12. Classifier: License :: OSI Approved :: Apache Software License
  13. Classifier: Programming Language :: Python
  14. Classifier: Programming Language :: Python :: 2
  15. Classifier: Programming Language :: Python :: 2.7
  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. Requires-Python: >= 2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*
  21. Requires-Dist: botocore (<1.21.0,>=1.20.112)
  22. Requires-Dist: jmespath (<1.0.0,>=0.7.1)
  23. Requires-Dist: s3transfer (<0.5.0,>=0.4.0)
  24. ===============================
  25. Boto3 - The AWS SDK for Python
  26. ===============================
  27. |Version| |Gitter|
  28. Boto3 is the Amazon Web Services (AWS) Software Development Kit (SDK) for
  29. Python, which allows Python developers to write software that makes use
  30. of services like Amazon S3 and Amazon EC2. You can find the latest, most
  31. up to date, documentation at our `doc site`_, including a list of
  32. services that are supported.
  33. On 01/15/2021 deprecation for Python 2.7 was announced and support will be dropped
  34. on 07/15/2021. To avoid disruption, customers using Boto3 on Python 2.7 may
  35. need to upgrade their version of Python or pin the version of Boto3. For
  36. 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/>`__.
  37. .. _boto: https://docs.pythonboto.org/
  38. .. _`doc site`: https://boto3.amazonaws.com/v1/documentation/api/latest/index.html
  39. .. |Gitter| image:: https://badges.gitter.im/boto/boto3.svg
  40. :target: https://gitter.im/boto/boto3
  41. :alt: Gitter
  42. .. |Downloads| image:: http://img.shields.io/pypi/dm/boto3.svg?style=flat
  43. :target: https://pypi.python.org/pypi/boto3/
  44. :alt: Downloads
  45. .. |Version| image:: http://img.shields.io/pypi/v/boto3.svg?style=flat
  46. :target: https://pypi.python.org/pypi/boto3/
  47. :alt: Version
  48. .. |License| image:: http://img.shields.io/pypi/l/boto3.svg?style=flat
  49. :target: https://github.com/boto/boto3/blob/develop/LICENSE
  50. :alt: License
  51. Getting Started
  52. ---------------
  53. Assuming that you have Python and ``virtualenv`` installed, set up your environment and install the required dependencies like this or you can install the library using ``pip``:
  54. .. code-block:: sh
  55. $ git clone https://github.com/boto/boto3.git
  56. $ cd boto3
  57. $ virtualenv venv
  58. ...
  59. $ . venv/bin/activate
  60. $ python -m pip install -r requirements.txt
  61. $ python -m pip install -e .
  62. .. code-block:: sh
  63. $ python -m pip install boto3
  64. Using Boto3
  65. ~~~~~~~~~~~~~~
  66. After installing boto3
  67. Next, set up credentials (in e.g. ``~/.aws/credentials``):
  68. .. code-block:: ini
  69. [default]
  70. aws_access_key_id = YOUR_KEY
  71. aws_secret_access_key = YOUR_SECRET
  72. Then, set up a default region (in e.g. ``~/.aws/config``):
  73. .. code-block:: ini
  74. [default]
  75. region=us-east-1
  76. Other credentials configuration method can be found `here <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html>`__
  77. Then, from a Python interpreter:
  78. .. code-block:: python
  79. >>> import boto3
  80. >>> s3 = boto3.resource('s3')
  81. >>> for bucket in s3.buckets.all():
  82. print(bucket.name)
  83. Running Tests
  84. ~~~~~~~~~~~~~
  85. You can run tests in all supported Python versions using ``tox``. By default,
  86. it will run all of the unit and functional tests, but you can also specify your own
  87. ``nosetests`` options. Note that this requires that you have all supported
  88. versions of Python installed, otherwise you must pass ``-e`` or run the
  89. ``nosetests`` command directly:
  90. .. code-block:: sh
  91. $ tox
  92. $ tox -- unit/test_session.py
  93. $ tox -e py26,py33 -- integration/
  94. You can also run individual tests with your default Python version:
  95. .. code-block:: sh
  96. $ nosetests tests/unit
  97. Getting Help
  98. ------------
  99. We use GitHub issues for tracking bugs and feature requests and have limited
  100. bandwidth to address them. Please use these community resources for getting
  101. help:
  102. * Ask a question on `Stack Overflow <https://stackoverflow.com/>`__ and tag it with `boto3 <https://stackoverflow.com/questions/tagged/boto3>`__
  103. * Come join the AWS Python community chat on `gitter <https://gitter.im/boto/boto3>`__
  104. * Open a support ticket with `AWS Support <https://console.aws.amazon.com/support/home#/>`__
  105. * If it turns out that you may have found a bug, please `open an issue <https://github.com/boto/boto3/issues/new>`__
  106. Contributing
  107. ------------
  108. 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.
  109. Maintenance and Support for SDK Major Versions
  110. ----------------------------------------------
  111. Boto3 was made generally available on 06/22/2015 and is currently in the full support phase of the availability life cycle.
  112. 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:
  113. * `AWS SDKs and Tools Maintenance Policy <https://docs.aws.amazon.com/credref/latest/refdocs/maint-policy.html>`__
  114. * `AWS SDKs and Tools Version Support Matrix <https://docs.aws.amazon.com/credref/latest/refdocs/version-support-matrix.html>`__
  115. More Resources
  116. --------------
  117. * `NOTICE <https://github.com/boto/boto3/blob/develop/NOTICE>`__
  118. * `Changelog <https://github.com/boto/boto3/blob/develop/CHANGELOG.rst>`__
  119. * `License <https://github.com/boto/boto3/blob/develop/LICENSE>`__