Python SDK for CloudPassage Halo API
Python Shell
Pull request Compare This branch is 347 commits ahead of apurvasingh:master.
Latest commit af936ef Feb 17, 2017 @mong2 mong2 committed on GitHub Merge pull request #64 from cloudpassage/develop
chg: usr: Improvents to list FIM baseline with detail information
Failed to load latest commit information.
cloudpassage Merge branch 'master' into develop Feb 18, 2017
docs/source chg: doc: Add documentation for contribution process !minor Dec 2, 2016
tests Changed the output FIM baseline to include more detail information Feb 17, 2017
.codeclimate.yml Removing duplication detector- we will use pyflakes Aug 16, 2016
.dockerignore Dockerfile-based travis config is now working Aug 16, 2016
.gitchangelog.rc New: .gitchangelog.rc now takes latest version from cloudpassage/__in… Oct 18, 2016
.gitignore Update gitignore Aug 15, 2016
.travis.yml travis to use docker for testing SDK Aug 16, 2016
CHANGELOG.rst Merge branch 'master' into develop Feb 18, 2017
Dockerfile chg: usr: Docker image now builds with git inside, syntax fix in test… Dec 2, 2016
LICENSE.txt Correcting grammar in LICENSE Aug 16, 2016 chg: usr: Updating README files with PyPI version badges. !minor Dec 2, 2016
README.rst chg: usr: Updating README files with PyPI version badges. !minor Dec 2, 2016
requirements-doc.txt Fix: Correcting docs build isssues, change revision to v0.101 Oct 17, 2016
requirements-testing.txt fix: typo = should be == in requirements-testing.txt Oct 11, 2016
requirements.txt Fixing testing deps Sep 7, 2016
setup.cfg Fixes to ease transition to flake8 Aug 17, 2016 Changing version to 1.0, removing beta references Nov 21, 2016 chg: usr: Improvements to server group creation, use grid-side input … Dec 21, 2016


Python SDK for CloudPassage Halo API

Documentation Status

Branch: master

Code Climate

Test Coverage

Build Status

Branch: develop

Build Status


PyPI version


  • 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"])


Browsing and downloading

Built documentation can be found at

Building documentation

  1. Clone the repository locally
  2. Navigate to cloudpassage-halo-python-sdk/docs
  3. run sphinx-build -b pdf source build/pdf
  4. Docs will be located at cloudpassage-halo-python-sdk/docs/build/pdf/CloudPassage_Python_SDK_$VERSION.pdf


Testing procedure is documented at: