https://github.com/pyapp-org/pyapp.aiobotocore

☁ AWS AIOBotocore Extension
https://github.com/pyapp-org/pyapp.aiobotocore

Last synced: 11 months ago
JSON representation

☁ AWS AIOBotocore Extension

• Host: GitHub
• URL: https://github.com/pyapp-org/pyapp.aiobotocore
• Owner: pyapp-org
• License: other
• Created: 2019-05-28T15:22:03.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-10-27T15:13:25.000Z (over 3 years ago)
• Last Synced: 2025-05-28T15:07:02.852Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 56.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
###################

pyApp - AIOBotocore

###################

*Let us handle the boring stuff!*

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

   :target: https://github.com/ambv/black

      :alt: Once you go Black...

.. image:: https://api.codeclimate.com/v1/badges/0a86755f39f0416fbd1e/maintainability

   :target: https://codeclimate.com/github/pyapp-org/pae.sqlalchemy/maintainability

   :alt: Maintainability

This extension provides `Session` and *client* factories for

`aiobotocore `_ to allow authorization

details to be configured via pyApp settings.

The extension also provides checks to confirm the settings are correct.

The extension now supports the standardised 

`pyApp-Messaging `_ interface.

Installation

============

Install using *pip*::

    pip install pyapp-aiobotocore

Install using *pipenv*::

    pipenv install pyapp-aiobotocore

Optionally add the `AWS_CREDENTIALS` block into your runtime settings file, this

is only required if you need to apply specific credentials, the default settings

provided by this extension work with assumed roles within of the AWS environment::

    AWS_CREDENTIALS = {

        "default": {

            "region_name": None,

            "aws_access_key_id": None,

            "aws_secret_access_key": None,

            "aws_session_token": None,

        }

    }

Usage

=====

The following example obtains an S3 client::

    from pyapp_ext.aiobotocore import create_client

    s3 = create_client("S3")

API

===

`pyapp_ext.aiobotocore.create_client(service_name: str, *, credentials: str = None, **client_kwargs)`

    Get an async botocore service client instance.

`pyapp_ext.aiobotocore.get_session(default: str = None) -> Session`

    Get named `Session` instance.