Metadata-Version: 1.1
Name: cloudpassage
Version: 1.1.1
Summary: Python SDK for CloudPassage Halo API
Home-page: http://github.com/cloudpassage/cloudpassage-halo-python-sdk
Author: CloudPassage
Author-email: toolbox@cloudpassage.com
License: BSD
Description-Content-Type: UNKNOWN
Description: cloudpassage-halo-python-sdk
        ============================
        
        Python SDK for CloudPassage Halo API
        ------------------------------------
        
        .. image:: https://readthedocs.org/projects/cloudpassage-halo-python-sdk/badge/?version=latest
        
        Branch: master
        
        .. image:: https://codeclimate.com/github/cloudpassage/cloudpassage-halo-python-sdk/badges/gpa.svg
           :target: https://codeclimate.com/github/cloudpassage/cloudpassage-halo-python-sdk
           :alt: Code Climate
        
        .. image:: https://codeclimate.com/github/cloudpassage/cloudpassage-halo-python-sdk/badges/coverage.svg
           :target: https://codeclimate.com/github/cloudpassage/cloudpassage-halo-python-sdk/coverage
           :alt: Test Coverage
        
        .. image:: https://travis-ci.org/cloudpassage/cloudpassage-halo-python-sdk.svg?branch=master
           :target: https://travis-ci.org/cloudpassage/cloudpassage-halo-python-sdk
        
        Branch: develop
        
        .. image:: https://travis-ci.org/cloudpassage/cloudpassage-halo-python-sdk.svg?branch=develop
           :target: https://travis-ci.org/cloudpassage/cloudpassage-halo-python-sdk
        
        
        Installation
        ------------
        
        .. image:: https://badge.fury.io/py/cloudpassage.svg
            :target: https://pypi.python.org/pypi/cloudpassage/
        
        Requirements:
        
        * requests
        * pyaml
        
        
        Install from pip with ``pip install cloudpassage``.  If you want to make
        modifications to the SDK you can install it in editable mode by downloading
        the source from this github repo, navigating to the top directory within the
        archive and running ``pip install -e .`` (note the . at the end).
        
        Quick Start
        -----------
        
        Here's the premise: you store your session configuration information (API
        credentials, proxy settings, etc) in the cloudpassage.HaloSession object.
        This object gets passed into the various class methods which allow you
        to interact with the CloudPassage Halo API.
        
        Practical example:
        We'll print a list of all servers in our account:
        
        ::
        
            import cloudpassage
        
            api_key = MY_HALO_API_KEY
            api_secret = MY_API_SECRET
            session = cloudpassage.HaloSession(api_key, api_secret)
            server = cloudpassage.Server(session)
        
            list_of_servers = server.list_all()
            for s in list_of_servers:
                print "ID: %s   Name: %s" % (s["id"], s["hostname"])
        
        
        
        Docs
        ====
        
        Where to download
        -----------------
        Documentation can be found at
        http://cloudpassage-halo-python-sdk.readthedocs.io/en/latest/?badge=latest
        
        Building documentation
        ----------------------
        
        1. Clone the repository locally
        1. Navigate to ``cloudpassage-halo-python-sdk/docs``
        1. run ``sphinx-build -b pdf source build/pdf``
        1. Docs will be located at ``cloudpassage-halo-python-sdk/docs/build/pdf/CloudPassage_Python_SDK_$VERSION.pdf``
        
        
        Testing
        =======
        
        Testing procedure is documented at: http://cloudpassage-halo-python-sdk.readthedocs.io/en/latest/testing.html
        
        
        
        
        
Keywords: cloudpassage halo api sdk
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Security
Classifier: License :: OSI Approved :: BSD License
