~vcs-imports/clientcookie/trunk

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: jjlee
  • Date: 2004-03-31 19:36:11 UTC
  • Revision ID: svn-v4:fd0d7bf2-dfb6-0310-8d31-b7ecfe96aada:user/jjlee/wwwsearch/ClientCookie:3571
Initial import

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
ClientCookie installation instructions
 
2
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
3
 
 
4
Dependencies
 
5
~~~~~~~~~~~~
 
6
 
 
7
Python 1.5.2 or above is required, and urllib2 is recommended.  Python
 
8
2.0 and above have urllib2 in the standard library, but the version of
 
9
urllib2 supplied with Python 2.0 is too old.  If you're using Python
 
10
2.0, either use the 1.5.2-compatible version (see below), or get the
 
11
version from Python 2.1 (available from the source distribution or CVS
 
12
from http://www.python.org/).  If you're using Python 1.5.2, there is
 
13
a 1.5.2-compatible urllib2.py available at
 
14
 
 
15
http://wwwsearch.sourceforge.net/
 
16
 
 
17
(these are derived from the 1.13.22 and 1.126.2.2 CVS releases, from
 
18
the Python 2.1 maintenance branch).  To install these, either overwrite
 
19
the old versions with these new ones, or place them somewhere in
 
20
sys.path ahead of the old ones, and rename them: urllib_152.py and
 
21
urllib2_152.py to urllib.py and urllib2.py respectively.
 
22
 
 
23
 
 
24
Installation
 
25
~~~~~~~~~~~~
 
26
 
 
27
To install the package, run the following command:
 
28
 
 
29
 python setup.py build
 
30
 
 
31
then (with appropriate permissions)
 
32
 
 
33
 python setup.py install
 
34
 
 
35
 
 
36
Alternatively, just copy the whole ClientCookie directory into your
 
37
Python path (eg. unix: /usr/local/lib/python2.2/site-packages,
 
38
Windows: C:\Python21, or C:\Python22\Lib\site-packages).  That's all
 
39
that setup.py does.  Only copy the ClientCookie directory that's
 
40
inside the distributed tarball / zip archive, not the entire
 
41
ClientCookie-x.x.x directory!
 
42
 
 
43
 
 
44
To run the functional tests (which DO access the network):
 
45
 
 
46
 python functional_tests.py
 
47
 
 
48
To run the unit tests (which DO NOT access the network):
 
49
 
 
50
 python test.py
 
51
 
 
52
This runs the unit tests against the source files extracted from the
 
53
package.  To run them against the installed copy of ClientCookie:
 
54
 
 
55
 python test.py -i
 
56
 
 
57
For help on other unit test options:
 
58
 
 
59
 python test.py --help
 
60
 
 
61
 
 
62
If you're using a pre-2.1 version of Python, you'll need to get
 
63
unittest.py (from http://pyunit.sourceforge.net) to run the tests.
 
64
 
 
65
If you run the tests on an Apple, or other non-unix, non-Windows
 
66
machine, please mail me the output along with details of the system
 
67
you ran them on.
 
68
 
 
69
Bugs and comments to jjl@pobox.com.
 
70
 
 
71
 
 
72
NO WARRANTY
 
73
 
 
74
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
 
75
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 
76
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 
77
 
 
78
Copyright Notices
 
79
 
 
80
  (C) 2002-2003 John J. Lee.  All rights reserved.
 
81
  (C) 1995-2001 Gisle Aas.  All rights reserved.   (Original LWP code)
 
82
  (C) 2002-2003 Johhny Lee.  All rights reserved.  (MSIE Perl code)
 
83
 
 
84
This code in this package is free software; you can redistribute it
 
85
and/or modify it under the terms of the BSD license (see the file
 
86
COPYING).
 
87
 
 
88
John J. Lee <jjl@pobox.com>
 
89
November 2003