Metadata-Version: 1.1
Name: ibm-cloud-sdk-core
Version: 1.0.0rc4
Summary: Client library for the IBM Cloud services
Home-page: https://github.com/IBM/python-sdk-core
Author: Erika Dsouza
Author-email: erika.dsouza@ibm.com
License: Apache 2.0
Description-Content-Type: UNKNOWN
Description: |Build Status| |codecov| |Latest Stable Version|
        
        python-sdk-core
        ===============
        
        This project contains the core functionality used by Python SDK's
        generated by the IBM OpenAPI 3 SDK Generator (openapi-sdkgen). Python
        code generated by openapi-sdkgen will depend on the function contained
        in this project.
        
        Installation
        ------------
        
        To install, use ``pip`` or ``easy_install``:
        
        .. code:: bash
        
            pip install --upgrade ibm-cloud-sdk-core
        
        or
        
        .. code:: bash
        
            easy_install --upgrade ibm-cloud-sdk-core
        
        Authentication Types
        --------------------
        
        There are several flavors of authentication supported in this package.
        To specify the intended authentication pattern to use, simply
        instantiate the ``Authenticator`` of your choice.
        
        Basic
        ~~~~~
        
        This indicates Basic Auth is to be used. Users will pass in a
        ``username`` and ``password`` and the SDK will generate a Basic Auth
        header to send with requests to the service.
        
        .. code:: py
        
            from ibm_cloud_sdk_core.authenticators import BasicAuthenticator
        
            authenticator = BasicAuthenticator(<your_username>, <your_password>)
        
        IAM
        ~~~
        
        This indicates that IAM token authentication is to be used. Users can
        pass in a ``apikey`` and the SDK will generate a Bearer Auth header to
        send with requests to the service.
        
        .. code:: py
        
            from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
        
            authenticator = IAMAuthenticator(<your_apikey>)
        
        Cloud Pak for Data
        ~~~~~~~~~~~~~~~~~~
        
        This indicates that the service is an instance of CP4D, which has its
        own version of token authentication. Users can pass in a ``username``,
        ``password`` and ``url``, and the SDK will generate a Bearer Auth header
        to send with requests to the service.
        
        .. code:: py
        
            from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator
        
            authenticator = CloudPakForDataAuthenticator(<your_username>, <your_password>, <your_url>)
        
        Bearer Token
        ~~~~~~~~~~~~
        
        This indicates bearer token authentication is to be used. The system
        would prepend the ``bearer`` name to your token and add it to the
        authorization header.
        
        .. code:: py
        
            from ibm_cloud_sdk_core.authenticators import BearerTokenAuthenticator
        
            authenticator = BearerTokenAuthenticator(<your_bearer_token>)
        
        No Authentication
        ~~~~~~~~~~~~~~~~~
        
        This indicates that no authentication is needed when sending requests to
        the service
        
        .. code:: py
        
            from ibm_cloud_sdk_core.authenticators import NoAuthAuthenticator
        
            authenticator = NoAuthAuthenticator()
        
        Issues
        ------
        
        If you encounter an issue with this project, you are welcome to submit a
        `bug report <https://github.com/IBM/python-sdk-core/issues>`__. Before
        opening a new issue, please search for similar issues. It's possible
        that someone has already reported it.
        
        Open source @ IBM
        -----------------
        
        Find more open source projects on the `IBM Github
        Page <http://github.com/IBM>`__
        
        License
        -------
        
        This library is licensed under Apache 2.0. Full license text is
        available in `LICENSE <LICENSE>`__.
        
        Contributing
        ------------
        
        See `CONTRIBUTING.md <CONTRIBUTING.md>`__.
        
        .. |Build Status| image:: https://travis-ci.com/IBM/python-sdk-core.svg?branch=master
           :target: https://travis-ci.com/IBM/python-sdk-core
        .. |codecov| image:: https://codecov.io/gh/IBM/python-sdk-core/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/IBM/python-sdk-core
        .. |Latest Stable Version| image:: https://img.shields.io/pypi/v/ibm-cloud-sdk-core.svg
           :target: https://pypi.python.org/pypi/ibm-cloud-sdk-core
        
Keywords: watson,ibm,cloud
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
