Skip to content

Commit

Permalink
clean up README
Browse files Browse the repository at this point in the history
  • Loading branch information
williamh committed Apr 5, 2012
1 parent 96bb373 commit 95a400e
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,25 @@
PyZilla
=======

PyZilla is a simple wrapper on top the xmlrpclib package which
PyZilla is a simple wrapper for the xmlrpclib package which
provides an object that can be used to make XML-RPC calls to a
Bugzilla installation.

The module exposes the ``BugZilla`` object which you can instantiate
with the uri to the ``xmlrpc.cgi`` file on your bugzilla installation.
It exposes the BugZilla object which you can instantiate with the uri
for the xmlrpc.cgi file on your bugzilla installation.

Here's a simple usage example::
Here's a simple usage example:

>>> from pyzilla import BugZilla
>>> bzilla = BugZilla("http://bugzilla.example.com/xmlrpc.cgi")
>>> bzilla.login("username", "password")
>>> bzilla.Bugzilla.version()

The module will store the auth cookies in the same directory of
invocation in a file called ``cookies.txt``.

For details of the API, please refer to the `Bugzilla webservice docs
<http://www.bugzilla.org/docs/3.0/html/api/Bugzilla/WebService.html>`_.

For a saner interface to bugzilla, please refer to the `Bugzilla
REST API <https://wiki.mozilla.org/Bugzilla:REST_API>`_.


For this example, the module will store the authentication cookies in
the current directory in a file named cookies.txt.

For details of the API, please refer to the Bugzilla webservice docs
<http://www.bugzilla.org/docs/3.0/html/api/Bugzilla/WebService.html>.

For a saner interface to bugzilla, please refer to the Bugzilla
REST API <https://wiki.mozilla.org/Bugzilla:REST_API>.

0 comments on commit 95a400e

Please sign in to comment.