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: and local file links support
- restrict link checking with regular expression filters for URLs
- proxy support
- username/password authorization for HTTP and FTP
- honors robots.txt exclusion protocol
- Cookie support
- HTML5 support
- a command line and web interface
- various check plugins available
Installation
-------------
Python 3.9 or later is needed. Using pip to install LinkChecker:
``pip3 install linkchecker``
pipx can also be used to 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: https://linkchecker.github.io/linkchecker/install.html
Usage
------
Execute ``linkchecker https://www.example.com``.
For other options see ``linkchecker --help``, and for more information the
manual pages `linkchecker(1)`_ and `linkcheckerrc(5)`_.
.. _linkchecker(1): https://linkchecker.github.io/linkchecker/man/linkchecker.html
.. _linkcheckerrc(5): https://linkchecker.github.io/linkchecker/man/linkcheckerrc.html
Docker usage
-------------
If you do not want to install any additional libraries/dependencies you can use
the Docker image which is published on GitHub Packages.
Example for external web site check::
docker run --rm -it -u $(id -u):$(id -g) ghcr.io/linkchecker/linkchecker:latest --verbose https://www.example.com
Local HTML file check::
docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt ghcr.io/linkchecker/linkchecker:latest --verbose index.html
In addition to the rolling latest image, uniquely tagged images can also be found
on the `packages`_ page.
.. _packages: https://github.com/linkchecker/linkchecker/pkgs/container/linkchecker
Raw data
{
"_id": null,
"home_page": null,
"name": "LinkChecker",
"maintainer": "LinkChecker Authors",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "checking, crawling, link, site, url, validation, verification",
"author": "LinkChecker Authors",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/db/8a/20cfbda1a4f5e9fd307cbb68dd15c2f14428deaf1eab89a79b9b7d03bf6e/LinkChecker-10.5.0.tar.gz",
"platform": null,
"description": "LinkChecker\n============\n\n|Build Status|_ |License|_\n\n.. |Build Status| image:: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml/badge.svg?branch=master\n.. _Build Status: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml\n.. |License| image:: https://img.shields.io/badge/license-GPL2-d49a6a.svg\n.. _License: https://opensource.org/licenses/GPL-2.0\n\nCheck for broken links in web sites.\n\nFeatures\n---------\n\n- recursive and multithreaded checking and site crawling\n- output in colored or normal text, HTML, SQL, CSV, XML or a sitemap graph in different formats\n- HTTP/1.1, HTTPS, FTP, mailto: and local file links support\n- restrict link checking with regular expression filters for URLs\n- proxy support\n- username/password authorization for HTTP and FTP\n- honors robots.txt exclusion protocol\n- Cookie support\n- HTML5 support\n- a command line and web interface\n- various check plugins available\n\nInstallation\n-------------\n\nPython 3.9 or later is needed. Using pip to install LinkChecker:\n\n``pip3 install linkchecker``\n\npipx can also be used to install LinkChecker.\n\nThe version in the pip repository may be old, to find out how to get the latest\ncode, plus platform-specific information and other advice see `doc/install.txt`_\nin the source code archive.\n\n.. _doc/install.txt: https://linkchecker.github.io/linkchecker/install.html\n\n\nUsage\n------\nExecute ``linkchecker https://www.example.com``.\nFor other options see ``linkchecker --help``, and for more information the\nmanual pages `linkchecker(1)`_ and `linkcheckerrc(5)`_.\n\n.. _linkchecker(1): https://linkchecker.github.io/linkchecker/man/linkchecker.html\n\n.. _linkcheckerrc(5): https://linkchecker.github.io/linkchecker/man/linkcheckerrc.html\n\nDocker usage\n-------------\n\nIf you do not want to install any additional libraries/dependencies you can use\nthe Docker image which is published on GitHub Packages.\n\nExample for external web site check::\n\n docker run --rm -it -u $(id -u):$(id -g) ghcr.io/linkchecker/linkchecker:latest --verbose https://www.example.com\n\nLocal HTML file check::\n\n docker run --rm -it -u $(id -u):$(id -g) -v \"$PWD\":/mnt ghcr.io/linkchecker/linkchecker:latest --verbose index.html\n\nIn addition to the rolling latest image, uniquely tagged images can also be found\non the `packages`_ page.\n\n.. _packages: https://github.com/linkchecker/linkchecker/pkgs/container/linkchecker\n",
"bugtrack_url": null,
"license": null,
"summary": "check links in web documents or full websites",
"version": "10.5.0",
"project_urls": {
"Bug Tracker": "https://github.com/linkchecker/linkchecker/issues",
"Changelog": "https://github.com/linkchecker/linkchecker/blob/master/doc/changelog.txt",
"Homepage": "https://linkchecker.github.io/linkchecker/",
"Repository": "https://github.com/linkchecker/linkchecker"
},
"split_keywords": [
"checking",
" crawling",
" link",
" site",
" url",
" validation",
" verification"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cdc68d6a8383a92fbd19337b7a3c4ed57042a3f39f57772774a11bd56316af2e",
"md5": "1d7da45d758e25f23217712c122a03d7",
"sha256": "eb25bf11c795eedc290f93311c497312f4e967e1c5b242b24ce3fc335b4c47c5"
},
"downloads": -1,
"filename": "LinkChecker-10.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1d7da45d758e25f23217712c122a03d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 280788,
"upload_time": "2024-09-03T18:42:45",
"upload_time_iso_8601": "2024-09-03T18:42:45.039370Z",
"url": "https://files.pythonhosted.org/packages/cd/c6/8d6a8383a92fbd19337b7a3c4ed57042a3f39f57772774a11bd56316af2e/LinkChecker-10.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db8a20cfbda1a4f5e9fd307cbb68dd15c2f14428deaf1eab89a79b9b7d03bf6e",
"md5": "a3104cb85fa1319381dc912b394e82f1",
"sha256": "978b42b803e58b7a8f6ffae1ff88fa7fd1e87b944403b5dc82380dd59f516bb9"
},
"downloads": -1,
"filename": "LinkChecker-10.5.0.tar.gz",
"has_sig": false,
"md5_digest": "a3104cb85fa1319381dc912b394e82f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 546451,
"upload_time": "2024-09-03T18:42:46",
"upload_time_iso_8601": "2024-09-03T18:42:46.612554Z",
"url": "https://files.pythonhosted.org/packages/db/8a/20cfbda1a4f5e9fd307cbb68dd15c2f14428deaf1eab89a79b9b7d03bf6e/LinkChecker-10.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-03 18:42:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "linkchecker",
"github_project": "linkchecker",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "beautifulsoup4",
"specs": [
[
">=",
"4.8.1"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.20"
]
]
},
{
"name": "dnspython",
"specs": [
[
">=",
"2.0"
]
]
},
{
"name": "argcomplete",
"specs": [
[
">=",
"1.8.1"
]
]
},
{
"name": "pdfminer.six",
"specs": [
[
">=",
"20181108"
]
]
}
],
"tox": true,
"lcname": "linkchecker"
}
JSON
