Skip to main content

Async client for aws services using botocore and aiohttp

Project description

https://travis-ci.org/aio-libs/aiobotocore.svg?branch=master https://codecov.io/gh/aio-libs/aiobotocore/branch/master/graph/badge.svg https://img.shields.io/pypi/v/aiobotocore.svg Chat on Gitter

Async client for amazon services using botocore and aiohttp/asyncio.

Main purpose of this library to support amazon s3 api, but other services should work (may be with minor fixes). For now we have tested only upload/download api for s3, other users report that SQS and Dynamo services work also. More tests coming soon.

Install

$ pip install aiobotocore

Basic Example

import asyncio
import aiobotocore

AWS_ACCESS_KEY_ID = "xxx"
AWS_SECRET_ACCESS_KEY = "xxx"


async def go(loop):
    bucket = 'dataintake'
    filename = 'dummy.bin'
    folder = 'aiobotocore'
    key = '{}/{}'.format(folder, filename)

    session = aiobotocore.get_session(loop=loop)
    async with session.create_client('s3', region_name='us-west-2',
                                   aws_secret_access_key=AWS_SECRET_ACCESS_KEY,
                                   aws_access_key_id=AWS_ACCESS_KEY_ID) as client:
        # upload object to amazon s3
        data = b'\x01'*1024
        resp = await client.put_object(Bucket=bucket,
                                            Key=key,
                                            Body=data)
        print(resp)

        # getting s3 object properties of file we just uploaded
        resp = await client.get_object_acl(Bucket=bucket, Key=key)
        print(resp)

        # get object from s3
        response = await client.get_object(Bucket=bucket, Key=key)
        # this will ensure the connection is correctly re-used/closed
        async with response['Body'] as stream:
            assert await stream.read() == data

        # list s3 objects using paginator
        paginator = client.get_paginator('list_objects')
        async for result in paginator.paginate(Bucket=bucket, Prefix=folder):
            for c in result.get('Contents', []):
                print(c)

        # delete object from s3
        resp = await client.delete_object(Bucket=bucket, Key=key)
        print(resp)

loop = asyncio.get_event_loop()
loop.run_until_complete(go(loop))

Supported AWS Services

This is a non-exuastive list of what tests aiobotocore runs against AWS services. Not all methods are tested but we aim to test the majority of commonly used methods.

Service

Status

S3

Working

DynamoDB

Basic methods tested

SNS

Basic methods tested

SQS

Basic methods tested

CloudFormation

Stack creation tested

Kinesis

Basic methods tested

Due to the way boto3 is implemented, its highly likely that even if services are not listed above that you can take any boto3.client(‘service’) and stick await infront of methods to make them async, e.g. await client.list_named_queries() would asynchronous list all of the named Athena queries.

If a service is not listed here and you could do with some tests or examples feel free to raise an issue.

Run Tests

Make sure you have development requirements installed and your amazon key and secret accessible via environment variables:

$ cd aiobotocore
$ export AWS_ACCESS_KEY_ID=xxx
$ export AWS_SECRET_ACCESS_KEY=xxx
$ pip install -Ur requirements-dev.txt

Execute tests suite:

$ py.test -v tests

Mailing List

https://groups.google.com/forum/#!forum/aio-libs

Requirements

awscli

awscli depends on a single version of botocore, however aiobotocore only supports a specific range of botocore versions. To ensure you install the latest version of awscli that your specific combination or aiobotocore and botocore can support use:

pip install -U aiobotocore[awscli]

Changes

0.9.1 (2018-05-04)

  • fix timeout bug introduced in last release

0.9.0 (2018-06-01)

  • bump aiohttp to 3.3.x

  • remove unneeded set_socket_timeout

0.8.0 (2018-05-07)

  • Fix pagination #573 (thanks @adamrothman)

  • Enabled several s3 tests via moto

  • Bring botocore up to date

0.7.0 (2018-05-01)

  • Just version bump

0.6.1a0 (2018-05-01)

  • bump to aiohttp 3.1.x

  • switch tests to Python 3.5+

  • switch to native coroutines

  • fix non-streaming body timeout retries

0.6.0 (2018-03-04)

  • Upgrade to aiohttp>=3.0.0 #536 (thanks @Gr1N)

0.5.3 (2018-02-23)

  • Fixed waiters #523 (thanks @dalazx)

  • fix conn_timeout #485

0.5.2 (2017-12-06)

  • Updated awscli dependency #461

0.5.1 (2017-11-10)

  • Disabled compressed response #430

0.5.0 (2017-11-10)

  • Fix error botocore error checking #190

  • Update supported botocore requirement to: >=1.7.28, <=1.7.40

  • Bump aiohttp requirement to support compressed responses correctly #298

0.4.5 (2017-09-05)

  • Added SQS examples and tests #336

  • Changed requirements.txt structure #336

  • bump to botocore 1.7.4

  • Added DynamoDB examples and tests #340

0.4.4 (2017-08-16)

  • add the supported versions of boto3 to extras require #324

0.4.3 (2017-07-05)

  • add the supported versions of awscli to extras require #273 (thanks @graingert)

0.4.2 (2017-07-03)

  • update supported aiohttp requirement to: >=2.0.4, <=2.3.0

  • update supported botocore requirement to: >=1.5.71, <=1.5.78

0.4.1 (2017-06-27)

  • fix redirects #268

0.4.0 (2017-06-19)

  • update botocore requirement to: botocore>=1.5.34, <=1.5.70

  • fix read_timeout due to #245

  • implement set_socket_timeout

0.3.3 (2017-05-22)

  • switch to PEP 440 version parser to support ‘dev’ versions

0.3.2 (2017-05-22)

  • Fix botocore integration

  • Provisional fix for aiohttp 2.x stream support

  • update botocore requirement to: botocore>=1.5.34, <=1.5.52

0.3.1 (2017-04-18)

  • Fixed Waiter support

0.3.0 (2017-04-01)

  • Added support for aiohttp>=2.0.4 (thanks @achimnol)

  • update botocore requirement to: botocore>=1.5.0, <=1.5.33

0.2.3 (2017-03-22)

  • update botocore requirement to: botocore>=1.5.0, <1.5.29

0.2.2 (2017-03-07)

  • set aiobotocore.__all__ for * imports #121 (thanks @graingert)

  • fix ETag in head_object response #132

0.2.1 (2017-02-01)

  • Normalize headers and handle redirection by botocore #115 (thanks @Fedorof)

0.2.0 (2017-01-30)

  • add support for proxies (thanks @jjonek)

  • remove AioConfig verify_ssl connector_arg as this is handled by the create_client verify param

  • remove AioConfig limit connector_arg as this is now handled by by the Config max_pool_connections property (note default is 10)

0.1.1 (2017-01-16)

  • botocore updated to version 1.5.0

0.1.0 (2017-01-12)

  • Pass timeout to aiohttp.request to enforce read_timeout #86 (thanks @vharitonsky) (bumped up to next semantic version due to read_timeout enabling change)

0.0.6 (2016-11-19)

  • Added enforcement of plain response #57 (thanks @rymir)

  • botocore updated to version 1.4.73 #74 (thanks @vas3k)

0.0.5 (2016-06-01)

  • Initial alpha release

Project details


Release history Release notifications | RSS feed

This version

0.9.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiobotocore-0.9.1.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

aiobotocore-0.9.1-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file aiobotocore-0.9.1.tar.gz.

File metadata

  • Download URL: aiobotocore-0.9.1.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for aiobotocore-0.9.1.tar.gz
Algorithm Hash digest
SHA256 d77db998feb2d737a4783ed6507694549cb6ffbaaa5de1758a7ffb07072912b6
MD5 2d358fcf7603f919795a4a600c289e48
BLAKE2b-256 23b2512fc59ba116f2bfb83f1d8fea58e4a9e2ecc5fae2bf1f95383674493049

See more details on using hashes here.

Provenance

File details

Details for the file aiobotocore-0.9.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aiobotocore-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bf9ed42e87745ac569e0f1b1b68f3ade21f73fdbf8e08ab3082618d69a5fa2f0
MD5 cdd0d83f57e41614bf2b10b49551433e
BLAKE2b-256 64b86fc94fd3aa13d03b06aadede4f99e0071bcdafcb3461adddcb7d6b18bf3e

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page