You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

153 lines
4.6 KiB

4 years ago
  1. Metadata-Version: 2.0
  2. Name: boto3
  3. Version: 1.9.71
  4. Summary: The AWS SDK for Python
  5. Home-page: https://github.com/boto/boto3
  6. Author: Amazon Web Services
  7. Author-email: UNKNOWN
  8. License: Apache License 2.0
  9. Platform: UNKNOWN
  10. Classifier: Development Status :: 5 - Production/Stable
  11. Classifier: Intended Audience :: Developers
  12. Classifier: Natural Language :: English
  13. Classifier: License :: OSI Approved :: Apache Software License
  14. Classifier: Programming Language :: Python
  15. Classifier: Programming Language :: Python :: 2.6
  16. Classifier: Programming Language :: Python :: 2.7
  17. Classifier: Programming Language :: Python :: 3
  18. Classifier: Programming Language :: Python :: 3.3
  19. Classifier: Programming Language :: Python :: 3.4
  20. Classifier: Programming Language :: Python :: 3.5
  21. Classifier: Programming Language :: Python :: 3.6
  22. Classifier: Programming Language :: Python :: 3.7
  23. Requires-Dist: botocore>=1.12.71,<1.13.0
  24. Requires-Dist: jmespath>=0.7.1,<1.0.0
  25. Requires-Dist: s3transfer>=0.1.10,<0.2.0
  26. ===============================
  27. Boto 3 - The AWS SDK for Python
  28. ===============================
  29. |Build Status| |Version| |Gitter|
  30. Boto3 is the Amazon Web Services (AWS) Software Development Kit (SDK) for
  31. Python, which allows Python developers to write software that makes use
  32. of services like Amazon S3 and Amazon EC2. You can find the latest, most
  33. up to date, documentation at our `doc site`_, including a list of
  34. services that are supported.
  35. .. _boto: https://docs.pythonboto.org/
  36. .. _`doc site`: https://boto3.amazonaws.com/v1/documentation/api/latest/index.html
  37. .. |Build Status| image:: http://img.shields.io/travis/boto/boto3/develop.svg?style=flat
  38. :target: https://travis-ci.org/boto/boto3
  39. :alt: Build Status
  40. .. |Gitter| image:: https://badges.gitter.im/boto/boto3.svg
  41. :target: https://gitter.im/boto/boto3
  42. :alt: Gitter
  43. .. |Downloads| image:: http://img.shields.io/pypi/dm/boto3.svg?style=flat
  44. :target: https://pypi.python.org/pypi/boto3/
  45. :alt: Downloads
  46. .. |Version| image:: http://img.shields.io/pypi/v/boto3.svg?style=flat
  47. :target: https://pypi.python.org/pypi/boto3/
  48. :alt: Version
  49. .. |License| image:: http://img.shields.io/pypi/l/boto3.svg?style=flat
  50. :target: https://github.com/boto/boto3/blob/develop/LICENSE
  51. :alt: License
  52. Quick Start
  53. -----------
  54. First, install the library and set a default region:
  55. .. code-block:: sh
  56. $ pip install boto3
  57. Next, set up credentials (in e.g. ``~/.aws/credentials``):
  58. .. code-block:: ini
  59. [default]
  60. aws_access_key_id = YOUR_KEY
  61. aws_secret_access_key = YOUR_SECRET
  62. Then, set up a default region (in e.g. ``~/.aws/config``):
  63. .. code-block:: ini
  64. [default]
  65. region=us-east-1
  66. Then, from a Python interpreter:
  67. .. code-block:: python
  68. >>> import boto3
  69. >>> s3 = boto3.resource('s3')
  70. >>> for bucket in s3.buckets.all():
  71. print(bucket.name)
  72. Development
  73. -----------
  74. Getting Started
  75. ~~~~~~~~~~~~~~~
  76. Assuming that you have Python and ``virtualenv`` installed, set up your
  77. environment and install the required dependencies like this instead of
  78. the ``pip install boto3`` defined above:
  79. .. code-block:: sh
  80. $ git clone https://github.com/boto/boto3.git
  81. $ cd boto3
  82. $ virtualenv venv
  83. ...
  84. $ . venv/bin/activate
  85. $ pip install -r requirements.txt
  86. $ pip install -e .
  87. Running Tests
  88. ~~~~~~~~~~~~~
  89. You can run tests in all supported Python versions using ``tox``. By default,
  90. it will run all of the unit and functional tests, but you can also specify your own
  91. ``nosetests`` options. Note that this requires that you have all supported
  92. versions of Python installed, otherwise you must pass ``-e`` or run the
  93. ``nosetests`` command directly:
  94. .. code-block:: sh
  95. $ tox
  96. $ tox -- unit/test_session.py
  97. $ tox -e py26,py33 -- integration/
  98. You can also run individual tests with your default Python version:
  99. .. code-block:: sh
  100. $ nosetests tests/unit
  101. Generating Documentation
  102. ~~~~~~~~~~~~~~~~~~~~~~~~
  103. Sphinx is used for documentation. You can generate HTML locally with the
  104. following:
  105. .. code-block:: sh
  106. $ pip install -r requirements-docs.txt
  107. $ cd docs
  108. $ make html
  109. Getting Help
  110. ------------
  111. We use GitHub issues for tracking bugs and feature requests and have limited
  112. bandwidth to address them. Please use these community resources for getting
  113. help:
  114. * Ask a question on `Stack Overflow <https://stackoverflow.com/>`__ and tag it with `boto3 <https://stackoverflow.com/questions/tagged/boto3>`__
  115. * Come join the AWS Python community chat on `gitter <https://gitter.im/boto/boto3>`__
  116. * Open a support ticket with `AWS Support <https://console.aws.amazon.com/support/home#/>`__
  117. * If it turns out that you may have found a bug, please `open an issue <https://github.com/boto/boto3/issues/new>`__