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.

239 lines
7.1 KiB

4 years ago
  1. Metadata-Version: 2.1
  2. Name: boto
  3. Version: 2.49.0
  4. Summary: Amazon Web Services Library
  5. Home-page: https://github.com/boto/boto/
  6. Author: Mitch Garnaat
  7. Author-email: mitch@garnaat.com
  8. License: MIT
  9. Platform: Posix; MacOS X; Windows
  10. Classifier: Development Status :: 5 - Production/Stable
  11. Classifier: Intended Audience :: Developers
  12. Classifier: License :: OSI Approved :: MIT License
  13. Classifier: Operating System :: OS Independent
  14. Classifier: Topic :: Internet
  15. Classifier: Programming Language :: Python :: 2
  16. Classifier: Programming Language :: Python :: 2.6
  17. Classifier: Programming Language :: Python :: 2.7
  18. Classifier: Programming Language :: Python :: 3
  19. Classifier: Programming Language :: Python :: 3.3
  20. Classifier: Programming Language :: Python :: 3.4
  21. ####
  22. boto
  23. ####
  24. boto 2.49.0
  25. Released: 11-July-2018
  26. .. image:: https://travis-ci.org/boto/boto.svg?branch=develop
  27. :target: https://travis-ci.org/boto/boto
  28. .. image:: https://pypip.in/d/boto/badge.svg
  29. :target: https://pypi.python.org/pypi/boto/
  30. ******
  31. Boto 3
  32. ******
  33. `Boto3 <https://github.com/boto/boto3>`__, the next version of Boto, is now
  34. stable and recommended for general use. It can be used side-by-side with Boto
  35. in the same project, so it is easy to start using Boto3 in your existing
  36. projects as well as new projects. Going forward, API updates and all new
  37. feature work will be focused on Boto3.
  38. To assist users who still depend on Boto and cannot immediately switch over, we
  39. will be triaging and addressing critical issues and PRs in Boto in the short
  40. term. As more users make the switch to Boto3, we expect to reduce our
  41. maintenance involvement over time. If we decide on a cutoff date or any
  42. significant changes to our maintenance plan, we will make pre-announcements
  43. well ahead of schedule to allow ample time for our users to adapt/migrate.
  44. ************
  45. Introduction
  46. ************
  47. Boto is a Python package that provides interfaces to Amazon Web Services.
  48. Currently, all features work with Python 2.6 and 2.7. Work is under way to
  49. support Python 3.3+ in the same codebase. Modules are being ported one at
  50. a time with the help of the open source community, so please check below
  51. for compatibility with Python 3.3+.
  52. To port a module to Python 3.3+, please view our `Contributing Guidelines`_
  53. and the `Porting Guide`_. If you would like, you can open an issue to let
  54. others know about your work in progress. Tests **must** pass on Python
  55. 2.6, 2.7, 3.3, and 3.4 for pull requests to be accepted.
  56. ********
  57. Services
  58. ********
  59. At the moment, boto supports:
  60. * Compute
  61. * Amazon Elastic Compute Cloud (EC2) (Python 3)
  62. * Amazon Elastic Map Reduce (EMR) (Python 3)
  63. * AutoScaling (Python 3)
  64. * Amazon Kinesis (Python 3)
  65. * AWS Lambda (Python 3)
  66. * Amazon EC2 Container Service (Python 3)
  67. * Content Delivery
  68. * Amazon CloudFront (Python 3)
  69. * Database
  70. * Amazon Relational Data Service (RDS)
  71. * Amazon DynamoDB (Python 3)
  72. * Amazon SimpleDB (Python 3)
  73. * Amazon ElastiCache (Python 3)
  74. * Amazon Redshift (Python 3)
  75. * Deployment and Management
  76. * AWS Elastic Beanstalk (Python 3)
  77. * AWS CloudFormation (Python 3)
  78. * AWS Data Pipeline (Python 3)
  79. * AWS Opsworks (Python 3)
  80. * AWS CloudTrail (Python 3)
  81. * AWS CodeDeploy (Python 3)
  82. * Administration & Security
  83. * AWS Identity and Access Management (IAM) (Python 3)
  84. * AWS Key Management Service (KMS) (Python 3)
  85. * AWS Config (Python 3)
  86. * AWS CloudHSM (Python 3)
  87. * Application Services
  88. * Amazon CloudSearch (Python 3)
  89. * Amazon CloudSearch Domain (Python 3)
  90. * Amazon Elastic Transcoder (Python 3)
  91. * Amazon Simple Workflow Service (SWF) (Python 3)
  92. * Amazon Simple Queue Service (SQS) (Python 3)
  93. * Amazon Simple Notification Server (SNS) (Python 3)
  94. * Amazon Simple Email Service (SES) (Python 3)
  95. * Amazon Cognito Identity (Python 3)
  96. * Amazon Cognito Sync (Python 3)
  97. * Amazon Machine Learning (Python 3)
  98. * Monitoring
  99. * Amazon CloudWatch (EC2 Only) (Python 3)
  100. * Amazon CloudWatch Logs (Python 3)
  101. * Networking
  102. * Amazon Route53 (Python 3)
  103. * Amazon Route 53 Domains (Python 3)
  104. * Amazon Virtual Private Cloud (VPC) (Python 3)
  105. * Elastic Load Balancing (ELB) (Python 3)
  106. * AWS Direct Connect (Python 3)
  107. * Payments and Billing
  108. * Amazon Flexible Payment Service (FPS)
  109. * Storage
  110. * Amazon Simple Storage Service (S3) (Python 3)
  111. * Amazon Glacier (Python 3)
  112. * Amazon Elastic Block Store (EBS)
  113. * Google Cloud Storage
  114. * Workforce
  115. * Amazon Mechanical Turk
  116. * Other
  117. * Marketplace Web Services (Python 3)
  118. * AWS Support (Python 3)
  119. The goal of boto is to support the full breadth and depth of Amazon
  120. Web Services. In addition, boto provides support for other public
  121. services such as Google Storage in addition to private cloud systems
  122. like Eucalyptus, OpenStack and Open Nebula.
  123. Boto is developed mainly using Python 2.6.6 and Python 2.7.3 on Mac OSX
  124. and Ubuntu Maverick. It is known to work on other Linux distributions
  125. and on Windows. Most of Boto requires no additional libraries or packages
  126. other than those that are distributed with Python. Efforts are made
  127. to keep boto compatible with Python 2.5.x but no guarantees are made.
  128. ************
  129. Installation
  130. ************
  131. Install via `pip`_:
  132. ::
  133. $ pip install boto
  134. Install from source:
  135. ::
  136. $ git clone git://github.com/boto/boto.git
  137. $ cd boto
  138. $ python setup.py install
  139. **********
  140. ChangeLogs
  141. **********
  142. To see what has changed over time in boto, you can check out the
  143. release notes at `http://docs.pythonboto.org/en/latest/#release-notes`
  144. ***************************
  145. Finding Out More About Boto
  146. ***************************
  147. The main source code repository for boto can be found on `github.com`_.
  148. The boto project uses the `gitflow`_ model for branching.
  149. `Online documentation`_ is also available. The online documentation includes
  150. full API documentation as well as Getting Started Guides for many of the boto
  151. modules.
  152. Boto releases can be found on the `Python Cheese Shop`_.
  153. Join our IRC channel `#boto` on FreeNode.
  154. Webchat IRC channel: http://webchat.freenode.net/?channels=boto
  155. Join the `boto-users Google Group`_.
  156. *************************
  157. Getting Started with Boto
  158. *************************
  159. Your credentials can be passed into the methods that create
  160. connections. Alternatively, boto will check for the existence of the
  161. following environment variables to ascertain your credentials:
  162. **AWS_ACCESS_KEY_ID** - Your AWS Access Key ID
  163. **AWS_SECRET_ACCESS_KEY** - Your AWS Secret Access Key
  164. Credentials and other boto-related settings can also be stored in a
  165. boto config file. See `this`_ for details.
  166. .. _Contributing Guidelines: https://github.com/boto/boto/blob/develop/CONTRIBUTING
  167. .. _Porting Guide: http://boto.readthedocs.org/en/latest/porting_guide.html
  168. .. _pip: http://www.pip-installer.org/
  169. .. _release notes: https://github.com/boto/boto/wiki
  170. .. _github.com: http://github.com/boto/boto
  171. .. _Online documentation: http://docs.pythonboto.org
  172. .. _Python Cheese Shop: http://pypi.python.org/pypi/boto
  173. .. _this: http://docs.pythonboto.org/en/latest/boto_config_tut.html
  174. .. _gitflow: http://nvie.com/posts/a-successful-git-branching-model/
  175. .. _neo: https://github.com/boto/boto/tree/neo
  176. .. _boto-users Google Group: https://groups.google.com/forum/?fromgroups#!forum/boto-users