[](https://github.com/butuzov/deadlinks/actions/workflows/main.yaml)
[](https://codecov.io/gh/butuzov/deadlinks)
[](https://pypi.org/project/deadlinks/)
[](https://pypi.org/project/deadlinks/)
[](https://pypi.org/project/deadlinks/)
---
Health checks for your documentation links.
[]([https://vshymanskyy.github.io/StandWithUkraine](https://stand-with-ukraine.pp.ua/))
## Features
- Concurrent and recursive checks
- Respect robots.txt restrictions (content only)
- External links checks
- Checking links within base url path
- Retries in the case of `502`, `503` and `504` http errors
## Installing
### Using package installer for Python
```bash
# using pip - package installer for Python
pip install deadlinks
```
### Mac
```bash
# we using custom tap to install deadlinks
brew install butuzov/deadlinks/deadlinks
```
### Using forked repo for development propose.
```bash
# activate virtual environment to keep your local site-packages clean.
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
# in case if you developing within forked repository
cd /home/path/to/deadlinks
pip install -r requirements.txt
pip install -e .
```
## Usage
See more examples at [docs](https://deadlinks.readthedocs.io/en/stable/)
```bash
# Check links (including external) at http://gobyexample.com/ in 10 threads,
# but not ones that leading to domains play.golang.org or github.com
deadlinks gobyexample.com -n 10 -e -d play.golang.org -d github.com
# Limiting check only to links found within /docs path.
deadlinks http://localhost:1313/docs
# Running checks for all local links that belong to a domain.
deadlinks http://localhost:1313/docs/ -n 10 --full-site-check
# Checking local html files
deadlinks internal -n 10 --root=/var/html
# Help yourself
deadlinks --help
```
## Contributing
Here is a quick start guide to contributing to `deadlinks`
- Fork `deadlinks` repository.
- Create `feature` branch based on `develop`.
- Install package using [development](#using-forked-repo-for-development-propose) instructions.
- Implement your feature and test it with `make tests` and `make lints`.
- Create `pull request` back to `development` branch.
All your contributions are welcome!
Raw data
{
"_id": null,
"home_page": "https://github.com/butuzov/deadlinks",
"name": "deadlinks",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "documentation,website,spider,crawler,link-checker",
"author": "Oleg Butuzov",
"author_email": "butuzov@made.ua",
"download_url": "https://files.pythonhosted.org/packages/1b/05/3e6ef8ca1e1808d9c9d2c9bdfcb78fa8d80e1e54dfd5608c3e9adcfc5474/deadlinks-0.3.5.tar.gz",
"platform": "MacOS",
"description": "[](https://github.com/butuzov/deadlinks/actions/workflows/main.yaml)\n[](https://codecov.io/gh/butuzov/deadlinks)\n[](https://pypi.org/project/deadlinks/)\n[](https://pypi.org/project/deadlinks/)\n[](https://pypi.org/project/deadlinks/)\n\n---\nHealth checks for your documentation links.\n\n\n[]([https://vshymanskyy.github.io/StandWithUkraine](https://stand-with-ukraine.pp.ua/))\n\n## Features\n\n- Concurrent and recursive checks\n- Respect robots.txt restrictions (content only)\n- External links checks\n- Checking links within base url path\n- Retries in the case of `502`, `503` and `504` http errors\n\n## Installing\n\n### Using package installer for Python\n\n```bash\n# using pip - package installer for Python\npip install deadlinks\n```\n\n### Mac\n\n```bash\n# we using custom tap to install deadlinks\nbrew install butuzov/deadlinks/deadlinks\n```\n\n### Using forked repo for development propose.\n\n```bash\n# activate virtual environment to keep your local site-packages clean.\npython3 -m venv .venv\nsource .venv/bin/activate\npip install --upgrade pip\n\n# in case if you developing within forked repository\ncd /home/path/to/deadlinks\npip install -r requirements.txt\npip install -e .\n```\n\n## Usage\n\nSee more examples at [docs](https://deadlinks.readthedocs.io/en/stable/)\n\n```bash\n# Check links (including external) at http://gobyexample.com/ in 10 threads,\n# but not ones that leading to domains play.golang.org or github.com\ndeadlinks gobyexample.com -n 10 -e -d play.golang.org -d github.com\n\n# Limiting check only to links found within /docs path.\ndeadlinks http://localhost:1313/docs\n\n# Running checks for all local links that belong to a domain.\ndeadlinks http://localhost:1313/docs/ -n 10 --full-site-check\n\n# Checking local html files\ndeadlinks internal -n 10 --root=/var/html\n\n# Help yourself\ndeadlinks --help\n```\n\n## Contributing\n\nHere is a quick start guide to contributing to `deadlinks`\n\n- Fork `deadlinks` repository.\n- Create `feature` branch based on `develop`.\n- Install package using [development](#using-forked-repo-for-development-propose) instructions.\n- Implement your feature and test it with `make tests` and `make lints`.\n- Create `pull request` back to `development` branch.\n\nAll your contributions are welcome!\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Health checks for your documentation links.",
"version": "0.3.5",
"project_urls": {
"Bugtracker": "https://github.com/butuzov/deadlinks/issues",
"Dockerized": "https://hub.docker.com/repository/docker/butuzov/deadlinks/",
"Documentation": "http://deadlinks.readthedocs.io/",
"Documentation (latest)": "https://deadlinks.readthedocs.io/en/latest/",
"GitHub: repo": "https://github.com/butuzov/deadlinks",
"Homepage": "https://github.com/butuzov/deadlinks"
},
"split_keywords": [
"documentation",
"website",
"spider",
"crawler",
"link-checker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b053e6ef8ca1e1808d9c9d2c9bdfcb78fa8d80e1e54dfd5608c3e9adcfc5474",
"md5": "57e841935d549329dfab0c2596cfda2d",
"sha256": "ec2d5584858d13a0a16967f96a8a377a658c0e36b933a900d7fd37e502e1e149"
},
"downloads": -1,
"filename": "deadlinks-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "57e841935d549329dfab0c2596cfda2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 29329,
"upload_time": "2023-12-31T15:19:54",
"upload_time_iso_8601": "2023-12-31T15:19:54.104812Z",
"url": "https://files.pythonhosted.org/packages/1b/05/3e6ef8ca1e1808d9c9d2c9bdfcb78fa8d80e1e54dfd5608c3e9adcfc5474/deadlinks-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-31 15:19:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "butuzov",
"github_project": "deadlinks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "deadlinks"
}
JSON
