mirror of
https://github.com/Hopiu/linkchecker.git
synced 2026-04-04 07:00:23 +00:00
check links in web documents or full websites
e297b1a477
Makes it easier to contribute and accept translations.
Does add a new dependency on installation from source, polib. This is
not made mandatory because not all users will want translations.
polib has no further dependencies and can be installed anywhere
LinkChecker can, using pip too.
Add release process step to check polib is installed
The Wheel still includes translations. Recommend install from PyPI in
the README.
Translations were being compiled in setup.py until 2014, using a bundled
copy of msgfmt.py.
|
||
|---|---|---|
| .github | ||
| cgi-bin | ||
| config | ||
| doc | ||
| linkcheck | ||
| po | ||
| scripts | ||
| tests | ||
| windows | ||
| .gitattributes | ||
| .gitignore | ||
| .project | ||
| .pydevproject | ||
| CODE_OF_CONDUCT.rst | ||
| CONTRIBUTING.rst | ||
| COPYING | ||
| dev-requirements.txt | ||
| Dockerfile | ||
| install-rpm.sh | ||
| linkchecker | ||
| Makefile | ||
| MANIFEST.in | ||
| pytest.ini | ||
| README.rst | ||
| requirements.txt | ||
| robots.txt | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
LinkChecker ============ |Build Status|_ |License|_ .. |Build Status| image:: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml/badge.svg?branch=master .. _Build Status: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml .. |License| image:: https://img.shields.io/badge/license-GPL2-d49a6a.svg .. _License: https://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 ------------- Python 3.6 or later is needed. Using pip to install LinkChecker: ``pip3 install linkchecker`` The version in the pip repository may be old, to find out how to get the latest code, plus platform-specific information and other advice see `doc/install.txt`_ in the source code archive. .. _doc/install.txt: doc/install.txt Usage ------ Execute ``linkchecker https://www.example.com``. For other options see ``linkchecker --help``. Docker usage ------------- *The Docker images are out-of-date, pip installation is the only currently recommended method.* If you do not want to install any additional libraries/dependencies you can use the Docker image. Example for external web site check:: docker run --rm -it -u $(id -u):$(id -g) linkchecker/linkchecker --verbose https://www.example.com Local HTML file check:: docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt linkchecker/linkchecker --verbose index.html