{"id":13762736,"url":"https://github.com/butuzov/deadlinks","last_synced_at":"2025-05-07T15:22:57.181Z","repository":{"id":35147924,"uuid":"208246196","full_name":"butuzov/deadlinks","owner":"butuzov","description":"Health checks for your documentation links.  https://pypi.org/project/deadlinks","archived":false,"fork":false,"pushed_at":"2024-07-06T09:22:09.000Z","size":1643,"stargazers_count":95,"open_issues_count":8,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-05T04:08:27.763Z","etag":null,"topics":["broken-links","cicd","docs","linter"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/butuzov.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://www.buymeacoffee.com/butuzov"]}},"created_at":"2019-09-13T10:53:06.000Z","updated_at":"2024-07-24T08:45:55.000Z","dependencies_parsed_at":"2024-01-07T14:23:50.578Z","dependency_job_id":"9de11fa4-e95d-4083-8950-0f1997e40511","html_url":"https://github.com/butuzov/deadlinks","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/butuzov%2Fdeadlinks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/butuzov%2Fdeadlinks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/butuzov%2Fdeadlinks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/butuzov%2Fdeadlinks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/butuzov","download_url":"https://codeload.github.com/butuzov/deadlinks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252903046,"owners_count":21822361,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["broken-links","cicd","docs","linter"],"created_at":"2024-08-03T14:00:55.998Z","updated_at":"2025-05-07T15:22:57.163Z","avatar_url":"https://github.com/butuzov.png","language":"Python","funding_links":["https://www.buymeacoffee.com/butuzov"],"categories":["Weapons","Python"],"sub_categories":["Tools"],"readme":"# deadlinks\n\n[![Stand with Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://u24.gov.ua/)\n[![PyPI](https://img.shields.io/pypi/v/deadlinks)](https://pypi.org/project/deadlinks/)\n[![Github (CI)](https://img.shields.io/github/actions/workflow/status/butuzov/deadlinks/main.yaml?branch=master)](https://github.com/butuzov/deadlinks/actions/workflows/main.yaml)\n[![codecov](https://codecov.io/gh/butuzov/deadlinks/branch/master/graph/badge.svg)](https://codecov.io/gh/butuzov/deadlinks)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/deadlinks)](https://pypi.org/project/deadlinks/)\n---\nHealth checks for your documentation links.\n---\n\n[![United 24](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-personal-page.svg)](https://u24.gov.ua/)\n[![Help Oleg Butuzov](https://raw.githubusercontent.com/butuzov/butuzov/main/personal.svg)](https://github.com/butuzov)\n\n---\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbutuzov%2Fdeadlinks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbutuzov%2Fdeadlinks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbutuzov%2Fdeadlinks/lists"}