python-qualysconnect / README

== Introduction ==

This is python-qualysconnect. A Python package that provides rudimentary access
to the QualysGuard (R) API (v1 and v2). This project is Copyright (c)
University of Waterloo and licensed under a BSD-new License.

The primary author of this package (to this point) is Colin Bell.

Contact @ Colin Bell <colin.bell@uwaterloo.ca>

== Installation ==

$ python setup.py install

NOTE: If you would like to experiment without installing globally, look into 'virtualenv'.

=== Requirements ===

You will need lxml installed for XML parsing in qhostinfo.py to work.

* http://lxml.de/

I've only tested this with Python 2.x.  I will need to test it with Python 3.x.

== Configuration ==

By default, the package will ask at the command prompt for username and
password.  By default, the package connects to the Qualys documented host
(qualysapi.qualys.com).  You can override these settings and prevent yourself
from typing credentials by creating a file called '.qcrc' in your home
directory.  (Sorry, I do not have this tested on Windows yet).

=== Example .qcrc ===

; Note, it should be possible to omit any of these entries.

[info]
hostname = qualysapi.serviceprovider.com
username = corp_tt
password = passw0rd

== Usage ==

A script called 'qhostinfo.py' is included and installed with setup.py.

Usage: qhostinfo.py [options]

Options:
  -h, --help            show this help message and exit
  -v, --verbose         Display detailed logging messages.
  -a IP, --address=IP   Display QualysGuard results for IP.
  -H HOSTNAME, --hostname=HOSTNAME
                        Display QualysGuard results for HOSTNAME.
Usage: qhostinfo.py [options]

== Source Code Examples ==

The bitbucket repository contains a directory called 'examples' that provides
barebones examples of the setup of a v1 and v2 connection.

https://bitbucket.org/uWaterloo_IST_ISS/python-qualysconnect/src
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.