ClientCookie installation instructions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Dependencies
~~~~~~~~~~~~

Python 1.5.2 or above is required, and urllib2 is recommended.  Python
2.0 and above have urllib2 in the standard library, but the version of
urllib2 supplied with Python 2.0 is too old.  If you're using Python
2.0, either use the 1.5.2-compatible version (see below), or get the
version from Python 2.1 (available from the source distribution or CVS
from http://www.python.org/).  If you're using Python 1.5.2, there is
a 1.5.2-compatible urllib2.py available at

http://wwwsearch.sourceforge.net/

(these are derived from the 1.13.22 and 1.126.2.2 CVS releases, from
the Python 2.1 maintenance branch).  To install these, either overwrite
the old versions with these new ones, or place them somewhere in
sys.path ahead of the old ones, and rename them: urllib_152.py and
urllib2_152.py to urllib.py and urllib2.py respectively.


Installation
~~~~~~~~~~~~

To install the package, run the following command:

 python setup.py build

then (with appropriate permissions)

 python setup.py install


Alternatively, just copy the whole ClientCookie directory into your
Python path (eg. unix: /usr/local/lib/python2.2/site-packages,
Windows: C:\Python21, or C:\Python22\Lib\site-packages).  That's all
that setup.py does.  Only copy the ClientCookie directory that's
inside the distributed tarball / zip archive, not the entire
ClientCookie-x.x.x directory!


To run the functional tests (which DO access the network):

 python functional_tests.py

To run the unit tests (which DO NOT access the network):

 python test.py

This runs the unit tests against the source files extracted from the
package.  To run them against the installed copy of ClientCookie:

 python test.py -i

For help on other unit test options:

 python test.py --help


If you're using a pre-2.1 version of Python, you'll need to get
unittest.py (from http://pyunit.sourceforge.net) to run the tests.

If you run the tests on an Apple, or other non-unix, non-Windows
machine, please mail me the output along with details of the system
you ran them on.

Bugs and comments to jjl@pobox.com.


NO WARRANTY

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

Copyright Notices

  (C) 2002-2003 John J. Lee.  All rights reserved.
  (C) 1995-2001 Gisle Aas.  All rights reserved.   (Original LWP code)
  (C) 2002-2003 Johhny Lee.  All rights reserved.  (MSIE Perl code)

This code in this package is free software; you can redistribute it
and/or modify it under the terms of the BSD license (see the file
COPYING).

John J. Lee <jjl@pobox.com>
November 2003
