Metadata-Version: 1.1
Name: pyramid_boto3
Version: 0.3
Summary: Adapt boto3 to pyramid
Home-page: https://github.com/gjo/pyramid_boto3
Author: OCHIAI, Gouji
Author-email: gjo.ext@gmail.com
License: BSD
Description: .. -*- coding: utf-8 -*-
        
        =============
        pyramid_boto3
        =============
        
        Adapt ``boto3`` to ``pyramid`` with ``pyramid_services``
        
        
        Install
        =======
        
        from PyPI::
        
          pip install pyramid_boto3
        
        
        How to use
        ==========
        
        In configuration phase, include ``pyramid_boto3`` after ``pyramid_services``::
        
          from pyramid.config import Configurator
        
          def main(global_config, **settings):
              config = Configurator(settings=settings)
              config.include('pyramid_boto3')
        
              # Your configuration
        
              return config.make_wsgi_app()
        
        
        In view or traversing, you can get predefined ``boto3``'s ``Client`` or
        ``Resource`` instances through ``request.find_service()``::
        
          @view_config()
          def some_view(request):
              client = request.find_service(name='boto3.client.filepot')
              client.list_buckets()
        
        
        You need to define servie's name (ex/ ``'boto3.client.filepot'``) and
        arguments in your config file::
        
          [app:main]
        
          # your-config
        
          boto3.cache_factory = threading.local
          boto3.sessions = mysession
          boto3.session.mysession.core.config_file = /path/to/aws/config.ini
          boto3.session.mysession.core.credentials_file = /path/to/aws/credentials.ini
          boto3.session.mysession.core.profile = prof1
          boto3.clients = filepot
          boto3.client.filepot.session = mysession
          boto3.client.filepot.service_name = s3
        
        
        Configuration Keys
        ==================
        
        +-----------------------------+-----------------------------------------------+
        | boto3.                      | namespace prefix                              |
        +-----------------------------+-----------------------------------------------+
        | boto3.cache_factory         | full qualified callable name.                 |
        |                             | default is ``threading.local``.               |
        |                             | if you would like to disable, set blank       |
        +-----------------------------+-----------------------------------------------+
        | boto3.sessions              | list of session's names                       |
        +-----------------------------+-----------------------------------------------+
        | boto3.session.NAME.*        | See: ``boto3.session.Session``'s docs.        |
        |                             | param ``botocore_session`` are created from   |
        |                             | blow ``core.`` sub params.                    |
        +-----------------------------+-----------------------------------------------+
        | boto3.session.NAME.core.    | See: ``botocore.session.Session``'s docs.     |
        +-----------------------------+-----------------------------------------------+
        | boto3.configs               | list of client config's names                 |
        +-----------------------------+-----------------------------------------------+
        | boto3.config.NAME.*         | See: ``botocore.config.Config``'s docs.       |
        +-----------------------------+-----------------------------------------------+
        | boto3.config.NAME.s3.*      | See: ``s3`` parameter in                      |
        |                             | ``botocore.config.Config``'s docs.            |
        +-----------------------------+-----------------------------------------------+
        | boto3.clients               | list of client's names                        |
        +-----------------------------+-----------------------------------------------+
        | boto3.client.NAME.session   | name of session to create client.             |
        +-----------------------------+-----------------------------------------------+
        | boto3.client.NAME.config    | (optional) name of config to create client.   |
        +-----------------------------+-----------------------------------------------+
        | boto3.client.NAME.*         | See: ``boto3.session.Session.client()``'s     |
        |                             | docs.                                         |
        +-----------------------------+-----------------------------------------------+
        | boto3.resources             | list of resource's names.                     |
        +-----------------------------+-----------------------------------------------+
        | boto3.resource.NAME.session | name of session to create resource.           |
        +-----------------------------+-----------------------------------------------+
        | boto3.resource.NAME.config  | (optional) name of config to create resource. |
        +-----------------------------+-----------------------------------------------+
        | boto3.resource.NAME.*       | See: ``boto3.session.Session.resource()``'s   |
        |                             | docs.                                         |
        +-----------------------------+-----------------------------------------------+
        
        
        Change History
        ==============
        
        0.3 - 2018-11-06
        ----------------
        - fixes imcompatibilities with botocore-1.12.38 later (#1)
        - include pre-requirements (``pyramid_services``)
        - drop python-3.3 support, add python-3.7 support
        - blackify and linted
        
        0.2.1 - 2017-06-14
        ------------------
        - fixes resource cache
        
        0.2 - 2017-06-14
        ----------------
        - ``botocore.session.Session.create_client`` does not support threading. See: boto/botocore#1033
        - per-thread cache.
        - tox support.
        - universal wheel support.
        
        0.1 - 2016-04-09
        ----------------
        - Initial release.
        
Platform: UNKNOWN
Classifier: Framework :: Pyramid
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
