check links in web documents or full websites
Find a file
Marius Gedminas ee3b590035 Tell tox to use develop mode
We must do this, because py.test adjusts sys.path to make
'tests.test_foo' importable [*].  When py.test does this, the
'linkcheck' directory at the top of the git tree is the one that gets
imported in the tests.  If we've told pip to use develop mode, all's
fine.  If we haven't, then we're going to get errors because extension
modules like _network.so get installed into
.tox/*/lib/*/site-packages/linkcheck/network and not into
./linkcheck/network/

[*] http://doc.pytest.org/en/latest/goodpractices.html#choosing-a-test-layout-import-rules
2017-02-01 18:24:21 +02:00
cgi-bin Updated homepage URL. 2013-04-09 20:11:04 +02:00
config Move GUI files to separate project 2016-01-23 13:28:15 +01:00
doc draft a release process 2017-01-31 12:25:57 -05:00
linkcheck Fix TypeError: hasattr(): attribute name must be string 2017-02-01 16:02:35 +02:00
po Move GUI files to separate project 2016-01-23 13:28:15 +01:00
scripts Code cleanup 2014-07-13 21:51:41 +02:00
tests Move GUI files to separate project 2016-01-23 13:28:15 +01:00
third_party More python3 fixes 2014-09-12 21:59:07 +02:00
windows Move GUI files to separate project 2016-01-23 13:28:15 +01:00
.gitattributes Add .gitattributes 2013-12-04 20:04:34 +01:00
.gitignore Add a tox.ini 2017-02-01 16:14:47 +02:00
.project Add Eclipse Pydev project files. 2011-05-18 21:12:18 +02:00
.pydevproject Updated pydev settings. 2011-12-17 19:13:43 +01:00
.travis.yml Run tox from Travis 2017-02-01 16:18:38 +02:00
COPYING Moved some files into the doc/ subdirectory. 2010-03-06 21:52:25 +01:00
install-rpm.sh Fix RPM installer generation. 2012-04-11 18:41:34 +02:00
linkchecker add --no-robots commandline flag 2016-05-19 14:43:59 -04:00
linkchecker.freecode Set release date. 2014-07-16 07:34:21 +02:00
Makefile Move GUI files to separate project 2016-01-23 13:28:15 +01:00
MANIFEST.in Move GUI files to separate project 2016-01-23 13:28:15 +01:00
README.rst Fix Travis badge in README 2017-01-31 17:18:47 +00:00
requirements.txt Replace twill with custom code. 2014-07-15 18:37:05 +02:00
robots.txt Add non-ascii values to test robots.txt 2008-07-13 13:01:59 +00:00
setup.cfg Remove platform-specific installer stuff and ensure a build .whl wheel file can be built. 2016-01-17 09:05:21 +01:00
setup.py Merge branch '9.3.x' 2017-01-31 19:21:22 -05:00
tox.ini Tell tox to use develop mode 2017-02-01 18:24:21 +02:00

LinkChecker
============

|Build Status|_ |Latest Version|_ |License|_

.. |Build Status| image:: https://travis-ci.org/linkcheck/linkchecker.svg?branch=master
.. _Build Status: https://travis-ci.org/linkcheck/linkchecker
.. |Latest Version| image:: http://img.shields.io/pypi/v/LinkChecker.svg
.. _Latest Version: https://pypi.python.org/pypi/LinkChecker
.. |License| image:: http://img.shields.io/badge/license-GPL2-d49a6a.svg
.. _License: http://opensource.org/licenses/GPL-2.0

Check for broken links in web sites.

Features
---------

- recursive and multithreaded checking and site crawling
- output in colored or normal text, HTML, SQL, CSV, XML or a sitemap graph in different formats
- HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:, Telnet and local file links support
- restrict link checking with regular expression filters for URLs
- proxy support
- username/password authorization for HTTP, FTP and Telnet
- honors robots.txt exclusion protocol
- Cookie support
- HTML5 support
- a command line and web interface
- various check plugins available, eg. HTML syntax and antivirus checks.

Installation
-------------
See doc/install.txt in the source code archive.
Python 2.7.2 or later is needed.

Usage
------
Execute ``linkchecker http://www.example.com``.
For other options see ``linkchecker --help``.