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