README.rst 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. ####
  2. boto
  3. ####
  4. boto 2.38.0
  5. Released: 9-Apr-2015
  6. .. image:: https://travis-ci.org/boto/boto.svg?branch=develop
  7. :target: https://travis-ci.org/boto/boto
  8. .. image:: https://pypip.in/d/boto/badge.svg
  9. :target: https://pypi.python.org/pypi/boto/
  10. ************
  11. Introduction
  12. ************
  13. Boto is a Python package that provides interfaces to Amazon Web Services.
  14. Currently, all features work with Python 2.6 and 2.7. Work is under way to
  15. support Python 3.3+ in the same codebase. Modules are being ported one at
  16. a time with the help of the open source community, so please check below
  17. for compatibility with Python 3.3+.
  18. To port a module to Python 3.3+, please view our `Contributing Guidelines`_
  19. and the `Porting Guide`_. If you would like, you can open an issue to let
  20. others know about your work in progress. Tests **must** pass on Python
  21. 2.6, 2.7, 3.3, and 3.4 for pull requests to be accepted.
  22. ******
  23. Boto 3
  24. ******
  25. The next major version of Boto is currently in developer preview and can
  26. be found in the `Boto 3 <https://github.com/boto/boto3#readme>`__
  27. repository and installed via ``pip``. It supports the latest service APIs
  28. and provides a high-level object-oriented interface to many services.
  29. Please try Boto 3 and
  30. `leave feedback <https://github.com/boto/boto3/issues>`__ with any issues,
  31. suggestions, and feature requests you might have.
  32. ********
  33. Services
  34. ********
  35. At the moment, boto supports:
  36. * Compute
  37. * Amazon Elastic Compute Cloud (EC2) (Python 3)
  38. * Amazon Elastic Map Reduce (EMR) (Python 3)
  39. * AutoScaling (Python 3)
  40. * Amazon Kinesis (Python 3)
  41. * AWS Lambda (Python 3)
  42. * Amazon EC2 Container Service (Python 3)
  43. * Content Delivery
  44. * Amazon CloudFront (Python 3)
  45. * Database
  46. * Amazon Relational Data Service (RDS)
  47. * Amazon DynamoDB (Python 3)
  48. * Amazon SimpleDB (Python 3)
  49. * Amazon ElastiCache (Python 3)
  50. * Amazon Redshift (Python 3)
  51. * Deployment and Management
  52. * AWS Elastic Beanstalk (Python 3)
  53. * AWS CloudFormation (Python 3)
  54. * AWS Data Pipeline (Python 3)
  55. * AWS Opsworks (Python 3)
  56. * AWS CloudTrail (Python 3)
  57. * AWS CodeDeploy (Python 3)
  58. * Administration & Security
  59. * AWS Identity and Access Management (IAM) (Python 3)
  60. * AWS Key Management Service (KMS) (Python 3)
  61. * AWS Config (Python 3)
  62. * AWS CloudHSM (Python 3)
  63. * Application Services
  64. * Amazon CloudSearch (Python 3)
  65. * Amazon CloudSearch Domain (Python 3)
  66. * Amazon Elastic Transcoder (Python 3)
  67. * Amazon Simple Workflow Service (SWF) (Python 3)
  68. * Amazon Simple Queue Service (SQS) (Python 3)
  69. * Amazon Simple Notification Server (SNS) (Python 3)
  70. * Amazon Simple Email Service (SES) (Python 3)
  71. * Amazon Cognito Identity (Python 3)
  72. * Amazon Cognito Sync (Python 3)
  73. * Amazon Machine Learning (Python 3)
  74. * Monitoring
  75. * Amazon CloudWatch (EC2 Only) (Python 3)
  76. * Amazon CloudWatch Logs (Python 3)
  77. * Networking
  78. * Amazon Route53 (Python 3)
  79. * Amazon Route 53 Domains (Python 3)
  80. * Amazon Virtual Private Cloud (VPC) (Python 3)
  81. * Elastic Load Balancing (ELB) (Python 3)
  82. * AWS Direct Connect (Python 3)
  83. * Payments and Billing
  84. * Amazon Flexible Payment Service (FPS)
  85. * Storage
  86. * Amazon Simple Storage Service (S3) (Python 3)
  87. * Amazon Glacier (Python 3)
  88. * Amazon Elastic Block Store (EBS)
  89. * Google Cloud Storage
  90. * Workforce
  91. * Amazon Mechanical Turk
  92. * Other
  93. * Marketplace Web Services (Python 3)
  94. * AWS Support (Python 3)
  95. The goal of boto is to support the full breadth and depth of Amazon
  96. Web Services. In addition, boto provides support for other public
  97. services such as Google Storage in addition to private cloud systems
  98. like Eucalyptus, OpenStack and Open Nebula.
  99. Boto is developed mainly using Python 2.6.6 and Python 2.7.3 on Mac OSX
  100. and Ubuntu Maverick. It is known to work on other Linux distributions
  101. and on Windows. Most of Boto requires no additional libraries or packages
  102. other than those that are distributed with Python. Efforts are made
  103. to keep boto compatible with Python 2.5.x but no guarantees are made.
  104. ************
  105. Installation
  106. ************
  107. Install via `pip`_:
  108. ::
  109. $ pip install boto
  110. Install from source:
  111. ::
  112. $ git clone git://github.com/boto/boto.git
  113. $ cd boto
  114. $ python setup.py install
  115. **********
  116. ChangeLogs
  117. **********
  118. To see what has changed over time in boto, you can check out the
  119. release notes at `http://docs.pythonboto.org/en/latest/#release-notes`
  120. ***************************
  121. Finding Out More About Boto
  122. ***************************
  123. The main source code repository for boto can be found on `github.com`_.
  124. The boto project uses the `gitflow`_ model for branching.
  125. `Online documentation`_ is also available. The online documentation includes
  126. full API documentation as well as Getting Started Guides for many of the boto
  127. modules.
  128. Boto releases can be found on the `Python Cheese Shop`_.
  129. Join our IRC channel `#boto` on FreeNode.
  130. Webchat IRC channel: http://webchat.freenode.net/?channels=boto
  131. Join the `boto-users Google Group`_.
  132. *************************
  133. Getting Started with Boto
  134. *************************
  135. Your credentials can be passed into the methods that create
  136. connections. Alternatively, boto will check for the existence of the
  137. following environment variables to ascertain your credentials:
  138. **AWS_ACCESS_KEY_ID** - Your AWS Access Key ID
  139. **AWS_SECRET_ACCESS_KEY** - Your AWS Secret Access Key
  140. Credentials and other boto-related settings can also be stored in a
  141. boto config file. See `this`_ for details.
  142. .. _Contributing Guidelines: https://github.com/boto/boto/blob/develop/CONTRIBUTING
  143. .. _Porting Guide: http://boto.readthedocs.org/en/latest/porting_guide.html
  144. .. _pip: http://www.pip-installer.org/
  145. .. _release notes: https://github.com/boto/boto/wiki
  146. .. _github.com: http://github.com/boto/boto
  147. .. _Online documentation: http://docs.pythonboto.org
  148. .. _Python Cheese Shop: http://pypi.python.org/pypi/boto
  149. .. _this: http://docs.pythonboto.org/en/latest/boto_config_tut.html
  150. .. _gitflow: http://nvie.com/posts/a-successful-git-branching-model/
  151. .. _neo: https://github.com/boto/boto/tree/neo
  152. .. _boto-users Google Group: https://groups.google.com/forum/?fromgroups#!forum/boto-users