The AWS SDK for Python
Project description
Licensed under the Apache License, Version 2.0 (the "License"). You
may not use this file except in compliance with the License. A copy of
the License is located at
http://aws.amazon.com/apache2.0/
or in the "license" file accompanying this file. This file is
distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express or implied. See the License for the specific
language governing permissions and limitations under the License.
Description: ===============================
Boto 3 - The AWS SDK for Python
===============================
|Build Status| |Coverage| |Docs| |Version| |Python Versions|
Boto is the Amazon Web Services (AWS) Software Development Kit (SDK) for
Python, which allows Python developers to write software that makes use
of services like Amazon S3 and Amazon EC2. You can find the latest, most
up to date, documentation at `Read the Docs`_, including a list of
services that are supported.
Boto 3 is in **developer preview**. This means that until a 1.0 release
occurs, some of the interfaces may change based on your feedback.
Once a 1.0 release happens, we guarantee backwards compatibility
for all future 1.x.x releases. Try out Boto 3 and give us
`feedback <https://github.com/boto/boto3/issues>`__ today!
.. _boto: https://docs.pythonboto.org/
.. _`Read the Docs`: https://boto3.readthedocs.org/en/latest/
.. |Build Status| image:: http://img.shields.io/travis/boto/boto3/develop.svg?style=flat
:target: https://travis-ci.org/boto/boto3
:alt: Build Status
.. |Coverage| image:: http://img.shields.io/coveralls/boto/boto3/develop.svg?style=flat
:target: https://coveralls.io/r/boto/boto3
:alt: Code Coverage
.. |Docs| image:: https://readthedocs.org/projects/boto3/badge/?version=latest&style=flat
:target: https://boto3.readthedocs.org/en/latest/
:alt: Read the docs
.. |Downloads| image:: http://img.shields.io/pypi/dm/boto3.svg?style=flat
:target: https://pypi-hypernode.com/pypi/boto3/
:alt: Downloads
.. |Version| image:: http://img.shields.io/pypi/v/boto3.svg?style=flat
:target: https://pypi-hypernode.com/pypi/boto3/
:alt: Version
.. |Python Versions| image:: https://pypip.in/py_versions/boto3/badge.svg?style=flat
:target: https://pypi-hypernode.com/pypi/boto3/
:alt: Python versions
.. |License| image:: http://img.shields.io/pypi/l/boto3.svg?style=flat
:target: https://github.com/boto/boto3/blob/develop/LICENSE
:alt: License
Quick Start
-----------
First, install the library and set a default region:
.. code-block:: sh
$ pip install boto3
Next, set up credentials (in e.g. ``~/.aws/credentials``):
.. code-block:: ini
[default]
aws_access_key_id = YOUR_KEY
aws_secret_access_key = YOUR_SECRET
Then, set up a default region (in e.g. ``~/.aws/config``):
.. code-block:: ini
[default]
region=us-east-1
Then, from a Python interpreter:
.. code-block:: python
>>> import boto3
>>> s3 = boto3.resource('s3')
>>> for bucket in s3.buckets.all():
print(bucket.name)
Development
-----------
Getting Started
~~~~~~~~~~~~~~~
Assuming that you have Python and ``virtualenv`` installed, set up your
environment and install the required dependencies like this instead of
the ``pip install boto3`` defined above:
.. code-block:: sh
$ git clone https://github.com/boto/boto3.git
$ cd boto3
$ virtualenv venv
...
$ . venv/bin/activate
$ pip install -r requirements.txt
$ pip install -e .
Running Tests
~~~~~~~~~~~~~
You can run tests in all supported Python versions using ``tox``. Be default,
it will run all of the unit tests, but you can also specify your own
``nosetests`` options. Note that this requires that you have all supported
versions of Python installed, otherwise you must pass ``-e`` or run the
``nosetests`` command directly:
.. code-block:: sh
$ tox
$ tox tests/unit/test_session.py
$ tox -e py26,py33 tests/integration
You can also run individual tests with your default Python version:
.. code-block:: sh
$ nosetests tests/unit
Generating Documentation
~~~~~~~~~~~~~~~~~~~~~~~~
Sphinx is used for documentation. You can generate HTML locally with the
following:
.. code-block:: sh
$ pip install sphinx sphinx_rtd_theme
$ cd docs
$ make html
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
may not use this file except in compliance with the License. A copy of
the License is located at
http://aws.amazon.com/apache2.0/
or in the "license" file accompanying this file. This file is
distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express or implied. See the License for the specific
language governing permissions and limitations under the License.
Description: ===============================
Boto 3 - The AWS SDK for Python
===============================
|Build Status| |Coverage| |Docs| |Version| |Python Versions|
Boto is the Amazon Web Services (AWS) Software Development Kit (SDK) for
Python, which allows Python developers to write software that makes use
of services like Amazon S3 and Amazon EC2. You can find the latest, most
up to date, documentation at `Read the Docs`_, including a list of
services that are supported.
Boto 3 is in **developer preview**. This means that until a 1.0 release
occurs, some of the interfaces may change based on your feedback.
Once a 1.0 release happens, we guarantee backwards compatibility
for all future 1.x.x releases. Try out Boto 3 and give us
`feedback <https://github.com/boto/boto3/issues>`__ today!
.. _boto: https://docs.pythonboto.org/
.. _`Read the Docs`: https://boto3.readthedocs.org/en/latest/
.. |Build Status| image:: http://img.shields.io/travis/boto/boto3/develop.svg?style=flat
:target: https://travis-ci.org/boto/boto3
:alt: Build Status
.. |Coverage| image:: http://img.shields.io/coveralls/boto/boto3/develop.svg?style=flat
:target: https://coveralls.io/r/boto/boto3
:alt: Code Coverage
.. |Docs| image:: https://readthedocs.org/projects/boto3/badge/?version=latest&style=flat
:target: https://boto3.readthedocs.org/en/latest/
:alt: Read the docs
.. |Downloads| image:: http://img.shields.io/pypi/dm/boto3.svg?style=flat
:target: https://pypi-hypernode.com/pypi/boto3/
:alt: Downloads
.. |Version| image:: http://img.shields.io/pypi/v/boto3.svg?style=flat
:target: https://pypi-hypernode.com/pypi/boto3/
:alt: Version
.. |Python Versions| image:: https://pypip.in/py_versions/boto3/badge.svg?style=flat
:target: https://pypi-hypernode.com/pypi/boto3/
:alt: Python versions
.. |License| image:: http://img.shields.io/pypi/l/boto3.svg?style=flat
:target: https://github.com/boto/boto3/blob/develop/LICENSE
:alt: License
Quick Start
-----------
First, install the library and set a default region:
.. code-block:: sh
$ pip install boto3
Next, set up credentials (in e.g. ``~/.aws/credentials``):
.. code-block:: ini
[default]
aws_access_key_id = YOUR_KEY
aws_secret_access_key = YOUR_SECRET
Then, set up a default region (in e.g. ``~/.aws/config``):
.. code-block:: ini
[default]
region=us-east-1
Then, from a Python interpreter:
.. code-block:: python
>>> import boto3
>>> s3 = boto3.resource('s3')
>>> for bucket in s3.buckets.all():
print(bucket.name)
Development
-----------
Getting Started
~~~~~~~~~~~~~~~
Assuming that you have Python and ``virtualenv`` installed, set up your
environment and install the required dependencies like this instead of
the ``pip install boto3`` defined above:
.. code-block:: sh
$ git clone https://github.com/boto/boto3.git
$ cd boto3
$ virtualenv venv
...
$ . venv/bin/activate
$ pip install -r requirements.txt
$ pip install -e .
Running Tests
~~~~~~~~~~~~~
You can run tests in all supported Python versions using ``tox``. Be default,
it will run all of the unit tests, but you can also specify your own
``nosetests`` options. Note that this requires that you have all supported
versions of Python installed, otherwise you must pass ``-e`` or run the
``nosetests`` command directly:
.. code-block:: sh
$ tox
$ tox tests/unit/test_session.py
$ tox -e py26,py33 tests/integration
You can also run individual tests with your default Python version:
.. code-block:: sh
$ nosetests tests/unit
Generating Documentation
~~~~~~~~~~~~~~~~~~~~~~~~
Sphinx is used for documentation. You can generate HTML locally with the
following:
.. code-block:: sh
$ pip install sphinx sphinx_rtd_theme
$ cd docs
$ make html
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
