summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorsyt <devnull@localhost>2006-05-05 14:20:44 +0000
committersyt <devnull@localhost>2006-05-05 14:20:44 +0000
commita120206e378545016e1b480724ee9b53e875f85b (patch)
treeaf2c92d72b7651691de456057f8faede3b983daf /README
parenteea76f1da01a33dec2afc42119e001e4350aaea2 (diff)
downloadpylint-a120206e378545016e1b480724ee9b53e875f85b.tar.gz
* new W0212 message for access to protected member from client code
* new W0212 message for access to protected member from client code * new W0105 message extracted from W0104 (statement seems to have no effect) with string
Diffstat (limited to 'README')
-rw-r--r--README119
1 files changed, 7 insertions, 112 deletions
diff --git a/README b/README
index ea4565f..fc5aaba 100644
--- a/README
+++ b/README
@@ -4,129 +4,26 @@ README for PyLint
Dependencies
------------
Pylint requires the logilab-astng (version >= 0.14), logilab-common
-(version >= 0.13) and the optik (only for python < 2.3) packages.
+(version >= 0.13) and the optik (only for python < 2.3) packages.
+Pylint should be compatible with any python >= 2.2.
* http://www.logilab.org/projects/astng
* http://www.logilab.org/projects/common
* http://optik.sourceforge.net/
-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. Pylint is also available in the standard Debian distribution
-
-Contributed RPM packages for pylint and logilab-common are available at
-ftp://ftp.nest.pld-linux.org/test .
-
-Pylint is also available in Gentoo, Fedora 4, Ubuntu, FreeBSD, Darwin.
-
-
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).
-
-
-IDE integration
----------------
-
-Pylint is integrated in the following editors/IDEs:
-
- * emacs (of course)
-
- * eric3
-
- * eclipse (using the pydev_ plugin, see also http://msdl.cs.mcgill.ca/MSDL/people/denis/meetings/pythonDev)
-
-To use pylint from within vim, see http://www.gonzo.kiev.ua/projects/pylint.vim
-
-_pydev: http://pydev.sourceforge.net
-
-Some projects using Pylint
---------------------------
-
- * The CheeseCake kwalitee reporting tool uses pylint to analyze the source code.
-
-The following projects use pylint to help develop better code:
-
- * http://browsershots.org
-
- * OSAF Chandler (http://www.osafoundation.org/)
-
- * CPS (http://www.nuxeo.org)
-
- * Xen (http://www.xensource.com/)
-
- * pyxmpp (http://pyxmpp.jabberstudio.org/)
-
- * eXe (http://exelearning.org/)
-
- * PrimaGIS (http://www.primagis.org)
-
- * python-cdd (http://projetos.ossystems.com.br/python-cdd/)
-
- * CDSWare (http://cdsware.cern.ch/)
-
- * ASE (http://dcwww.camp.dtu.dk/campos/ASE/intro.html)
-
- * RunJob (http://projects.fnal.gov/runjob/)
-
- * Slugathon (http://slugathon.python-hosting.com/)
-
- * mercurial
-
- * Topographica (http://topographica.org/Home/index.html) (at least they intend to do so)
+You'll have to install dependancies in a similar way. For debian and
+rpm packages, use your usual tools according to your Linux distribution.
- * ERP5 (http://www.erp5.org/)
+More information about installation and available distribution format
+may be found in the user manual in the *doc* subdirectory.
- * many more...
Documentation
-------------
@@ -145,12 +42,10 @@ 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
+* Sylvain Thénault: main author / maintainer
* Alexandre Fayolle: TkInter gui, documentation, debian support
* Brian van den Broek: windows installation documentation
* Amaury Forgeot d'Arc: patch to check names imported from a module