README for PyLint
=================

Dependencies
------------
Pylint requires the logilab-common(version >= 0.3.4) and the optik (only for
python < 2.3) packages.


Distributions
-------------
The source tarball is available at ftp://ftp.logilab.fr/pub/pylint.

You may apt-get a debian package by adding ::

    deb ftp://ftp.logilab.org/pub/debian unstable/

to your /etc/apt/sources.list files. In bonus

Contributed RPM packages for pylint and logilab-common are available at
ftp://ftp.nest.pld-linux.org/test .


Install
-------
From the source distribution, extract the tarball and run ::

    python setup.py install

For debian and rpm packages, use your usual tools according to your Linux
distribution. 

Note for Windows users:
On Windows, once you have installed pylint, the command line usage is
pylint.bat [options] module_or_package

But this will only work if pylint.bat is either in the current
directory, or on your system path. (setup.py install install python.bat
to the Scripts subdirectory of your Python installation -- e.g.
C:\Python24\Scripts.) You can do any of the following to solve this:

1. change to the appropriate directory before running pylint.bat

2. add the Scripts directory to your path statement in your autoexec.bat
   file (this file is found in the root directory of your boot-drive)

3. create a 'redirect' batch file in a directory actually on your
   systems path

To effect (2), simply append the appropriate directory name to the PATH=
statement in autoexec.bat. Be sure to use the Windows directory
separator of ';' between entries. Then, once you have rebooted (this is
necessary so that the new path statement will take effect when
autoexec.bat is run), you will be able to invoke PyLint with
pylint.bat on the command line.

(3) is the best solution. Once done, you can call pylint at the command
line without the .bat, just as do non-Windows users by typing: ::

  pylint [options] module_or_package

To effect option (3), simply create a plain text file pylint.bat with
the single line: ::

  C:\PythonDirectory\Scripts\pylint.bat

(where PythonDirectory is replaced by the actual Python installation
directory on your system -- e.g. C:\Python24\Scripts\pylint.bat).


Documentation
-------------
Look in the doc/ subdirectory.


Comments, support, bug reports
------------------------------
Use the python-projects@logilab.org mailing list. Since we do not have
publicly available bug tracker yet, bug reports should be emailed
there too. 

You can subscribe to this mailing list at
http://www.logilab.org/mailinglists/python_projects/mailinglist_register_form

Archives are available at 
http://lists.logilab.org/pipermail/python-projects/

If you prefer speaking french instead of english, you can use the
generic forum-fr@logilab.org mailing list.

Contributors
------------
* Sylvain Thenault: main author / maintainer
* Alexandre Fayolle: TkInter gui, documentation
* Brian van den Broek: windows installation documentation
* Wolfgang Grafen: feedback, feature requests such as message identifiers
* Axel Muller: bug reports
* Fabio Zadrozny: bug reports
* All the Logilab's team: daily use, bug reports, feature requests
* Other people have contributed by their feedback, if I've forgotten
  you, send me a note !