Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/butuzov/deadlinks
Health checks for your documentation links. https://pypi.org/project/deadlinks
https://github.com/butuzov/deadlinks
broken-links cicd docs linter
Last synced: 2 days ago
JSON representation
Health checks for your documentation links. https://pypi.org/project/deadlinks
- Host: GitHub
- URL: https://github.com/butuzov/deadlinks
- Owner: butuzov
- License: apache-2.0
- Created: 2019-09-13T10:53:06.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T02:25:54.000Z (2 months ago)
- Last Synced: 2024-04-22T04:17:06.756Z (2 months ago)
- Topics: broken-links, cicd, docs, linter
- Language: Python
- Homepage:
- Size: 1.56 MB
- Stars: 93
- Watchers: 6
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- WebHackersWeapons - deadlinks - link`](/categorize/tags/broken-link.md)|[](/categorize/langs/Python.md)| (Weapons / Tools)
- project-awesome - butuzov/deadlinks - Health checks for your documentation links. https://pypi.org/project/deadlinks (Python)
README
# deadlinks
[](https://pypi.org/project/deadlinks/)
[](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!