PageRenderTime 39ms CodeModel.GetById 14ms RepoModel.GetById 1ms app.codeStats 0ms

/boto-2.5.2/README.rst

#
ReStructuredText | 100 lines | 81 code | 19 blank | 0 comment | 0 complexity | 080b7e7bfeb1ca965c5339c340f8704c MD5 | raw file
    

  1. ####
    2. 

  2. boto
    3. 

  3. ####
    4. 

  4. boto 2.5.2
    5. 

  5. 21-Jun-2012
    6. 

  6. 

  7. ************
    8. 

  8. Introduction
    9. 

  9. ************
    10. 

  10. 

  11. Boto is a Python package that provides interfaces to Amazon Web Services.
    12. 

  12. At the moment, boto supports:
    13. 

  13. 

  14. * Simple Storage Service (S3)
    15. 

  15. * SimpleQueue Service (SQS)
    16. 

  16. * Elastic Compute Cloud (EC2)
    17. 

  17. * Mechanical Turk
    18. 

  18. * SimpleDB
    19. 

  19. * CloudFront
    20. 

  20. * CloudWatch
    21. 

  21. * AutoScale
    22. 

  22. * Elastic Load Balancer (ELB)
    23. 

  23. * Virtual Private Cloud (VPC)
    24. 

  24. * Elastic Map Reduce (EMR)
    25. 

  25. * Relational Data Service (RDS)
    26. 

  26. * Simple Notification Server (SNS)
    27. 

  27. * Google Storage
    28. 

  28. * Identity and Access Management (IAM)
    29. 

  29. * Route53 DNS Service (route53)
    30. 

  30. * Simple Email Service (SES)
    31. 

  31. * Flexible Payment Service (FPS)
    32. 

  32. * CloudFormation
    33. 

  33. * Amazon DynamoDB
    34. 

  34. * Amazon SimpleWorkflow
    35. 

  35. * CloudSearch
    36. 

  36. * Marketplace Web Services
    37. 

  37. 

  38. The goal of boto is to support the full breadth and depth of Amazon
    39. 

  39. Web Services.  In addition, boto provides support for other public
    40. 

  40. services such as Google Storage in addition to private cloud systems
    41. 

  41. like Eucalyptus, OpenStack and Open Nebula.
    42. 

  42. 

  43. Boto is developed mainly using Python 2.6.6 and Python 2.7.1 on Mac OSX
    44. 

  44. and Ubuntu Maverick.  It is known to work on other Linux distributions
    45. 

  45. and on Windows.  Boto requires no additional libraries or packages
    46. 

  46. other than those that are distributed with Python.  Efforts are made
    47. 

  47. to keep boto compatible with Python 2.5.x but no guarantees are made.
    48. 

  48. 

  49. *********************************
    50. 

  50. Special Note for Python 3.x Users
    51. 

  51. *********************************
    52. 

  52. 

  53. If you are interested in trying out boto with Python 3.x, check out the
    54. 

  54. `neo`_ branch.  This is under active development and the goal is a version
    55. 

  55. of boto that works in Python 2.6, 2.7, and 3.x.  Not everything is working
    56. 

  56. just yet but many things are and it's worth a look if you are an active
    57. 

  57. Python 3.x user.
    58. 

  58. 

  59. ***************************
    60. 

  60. Finding Out More About Boto
    61. 

  61. ***************************
    62. 

  62. 

  63. The main source code repository for boto can be found on `github.com`_.
    64. 

  64. The boto project uses the `gitflow`_ model for branching.
    65. 

  65. 

  66. `Online documentation`_ is also available. The online documentation includes
    67. 

  67. full API documentation as well as Getting Started Guides for many of the boto
    68. 

  68. modules.
    69. 

  69. 

  70. Boto releases can be found on the `Python Cheese Shop`_.
    71. 

  71. 

  72. Join our IRC channel `#boto` on FreeNode.
    73. 

  73. Webchat IRC channel: http://webchat.freenode.net/?channels=boto
    74. 

  74. 

  75. *************************
    76. 

  76. Getting Started with Boto
    77. 

  77. *************************
    78. 

  78. 

  79. Your credentials can be passed into the methods that create
    80. 

  80. connections.  Alternatively, boto will check for the existance of the
    81. 

  81. following environment variables to ascertain your credentials:
    82. 

  82. 

  83. **AWS_ACCESS_KEY_ID** - Your AWS Access Key ID
    84. 

  84. 

  85. **AWS_SECRET_ACCESS_KEY** - Your AWS Secret Access Key
    86. 

  86. 

  87. Credentials and other boto-related settings can also be stored in a
    88. 

  88. boto config file.  See `this`_ for details.
    89. 

  89. 

  90. Copyright (c) 2006-2012 Mitch Garnaat <mitch@garnaat.com>
    91. 

  91. Copyright (c) 2010-2011, Eucalyptus Systems, Inc.
    92. 

  92. Copyright (c) 2012 Amazon.com, Inc. or its affiliates.
    93. 

  93. All rights reserved.
    94. 

  94. 

  95. .. _github.com: http://github.com/boto/boto
    96. 

  96. .. _Online documentation: http://docs.pythonboto.org
    97. 

  97. .. _Python Cheese Shop: http://pypi.python.org/pypi/boto
    98. 

  98. .. _this: http://code.google.com/p/boto/wiki/BotoConfig
    99. 

  99. .. _gitflow: http://nvie.com/posts/a-successful-git-branching-model/
    100. 

  100. .. _neo: https://github.com/boto/boto/tree/neo
    101. 

  101.