{ "info": { "author": "Oleg Butuzov", "author_email": "butuzov@made.ua", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Operating System :: MacOS", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3 :: Only", "Topic :: Documentation", "Topic :: Utilities" ], "description": "[![PyPI](https://img.shields.io/pypi/v/deadlinks)](https://pypi.org/project/deadlinks/)\n[![Travis (.org)](https://img.shields.io/travis/butuzov/deadlinks/master)](https://travis-ci.org/butuzov/deadlinks)\n[![codecov](https://codecov.io/gh/butuzov/deadlinks/branch/master/graph/badge.svg)](https://codecov.io/gh/butuzov/deadlinks)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cff8901ed5974425a61dff833f8f81b8)](https://codacy.com/manual/butuzov/deadlinks)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/deadlinks)\n![PyPI - License](https://img.shields.io/pypi/l/deadlinks?color=%23ecac1b)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/deadlinks)](https://pypi.org/project/deadlinks/)\n---\n\n**deadlinks** is a simple cli tool to check your documentation/website for deadlinks.\n\n## Features\n\n- Concurrent and recursive checks\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### 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\n\n# if you using Python 3.5 on the mac, install new version of pip\ncurl https://bootstrap.pypa.io/get-pip.py | python3.5\n# if you using other version, just upgrade pip\npip install --upgrade pip\n\n# in case if you developing within forked repository\ncd /home/user/deadlinks-fork\npip install -r requirments.txt\npip install -e .\n```\n\n## Usage\n\nSee more examples at [docs](https://github.com/butuzov/deadlinks/blob/develop/docs/examples.md)\n\n```bash\n# run 10 instances of crawler against https://gobyexample.com.ua\n# with the additional check for the external links (except ones that\n# match play.golang.org)\ndeadlinks https://gobyexample.com.ua -n 10 -e -d play.golang.org\n\n# get more help with\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\n## Alternatives\n\nThese are a lot of alternative ways to check your website for dead links errors, you can check a [open software](https://github.com/topics/link-checker) or check other options:\n\n| Platform | Title | Link |\n|--------------------|----------------------------|---------------------------------------------------------------------|\n| `mac`, `ui` | Integrity | |\n| `win`, `ui` | Xenu's Link Sleuth | |\n| `web` | Online Broken Link Checker | |\n| `web` | Free Broken Link Tool | |\n| `win`, `ui` | InterroBot | |\n| `go`, `cli` | muffet | |\n| `cli`, `ui`, `web` | linkchecker | |\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/butuzov/deadlinks", "keywords": "documentation,website,spider,crawler,link-checker", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "deadlinks", "package_url": "https://pypi.org/project/deadlinks/", "platform": "MacOS", "project_url": "https://pypi.org/project/deadlinks/", "project_urls": { "Homepage": "https://github.com/butuzov/deadlinks" }, "release_url": "https://pypi.org/project/deadlinks/0.0.2/", "requires_dist": [ "requests (>=2.22.0)", "click (==7.0)", "urllib3 (==1.25.6)", "requests (>=2.22.0) ; extra == 'all'", "click (==7.0) ; extra == 'all'", "urllib3 (==1.25.6) ; extra == 'all'", "pytest (>=4.4.1) ; extra == 'all'", "pytest-randomly (>=3.1.0) ; extra == 'all'", "pytest-timeout (>=1.3.3) ; extra == 'all'", "coverage (>=4.5.3) ; extra == 'all'", "pytest-cov (>=2.6.1) ; extra == 'all'", "pytest-xdist (>=1.29.0) ; extra == 'all'", "pylint (>=2.3.1) ; extra == 'all'", "yapf (>=0.28.0) ; extra == 'all'", "mypy (>=0.701) ; extra == 'all'", "pylint (>=2.3.1) ; extra == 'lint'", "yapf (>=0.28.0) ; extra == 'lint'", "mypy (>=0.701) ; extra == 'lint'", "pytest (>=4.4.1) ; extra == 'test'", "pytest-randomly (>=3.1.0) ; extra == 'test'", "pytest-timeout (>=1.3.3) ; extra == 'test'", "coverage (>=4.5.3) ; extra == 'test'", "pytest-cov (>=2.6.1) ; extra == 'test'", "pytest-xdist (>=1.29.0) ; extra == 'test'" ], "requires_python": ">=3.5", "summary": "CLI/API for links liveness checking.", "version": "0.0.2" }, "last_serial": 6000775, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "b8dc7ee941baf61197eb34c180081d7c", "sha256": "7a972268bf89675e96776d560b4adfd12d44020bec80fe5222c755ac58986ba3" }, "downloads": -1, "filename": "deadlinks-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b8dc7ee941baf61197eb34c180081d7c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 27514, "upload_time": "2019-10-11T20:24:41", "url": "https://files.pythonhosted.org/packages/f7/59/7aa99e0ecde0b202c8a94f229ccb9506157b22937558a2467dccc13622e4/deadlinks-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1bd4bf7c639c0b8a872a25feb517de6d", "sha256": "ab8533d32c3e23cae34ddffdcc1f9206730b04503c5b7a1c53db8f7172c1f3a3" }, "downloads": -1, "filename": "deadlinks-0.0.1.tar.gz", "has_sig": false, "md5_digest": "1bd4bf7c639c0b8a872a25feb517de6d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 17853, "upload_time": "2019-10-11T20:24:43", "url": "https://files.pythonhosted.org/packages/2d/62/cf27edcdf796fd2eac63e3cd589f07cefb94271c0e07664b40316602290f/deadlinks-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "c591c64a55b4e10688bb24469b439910", "sha256": "632f7b8545a2cf263de42456a5a385bfb12405bd4f0c25cb51b5f7018cf4f1ca" }, "downloads": -1, "filename": "deadlinks-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "c591c64a55b4e10688bb24469b439910", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 29026, "upload_time": "2019-10-19T19:13:59", "url": "https://files.pythonhosted.org/packages/ba/6f/6828cf167ae840d7ea769b2c2a5e89a2279e7830af48b6c20e57be52cb98/deadlinks-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fdd9acb2ec99ef762afd80585c5a7918", "sha256": "ac66fb68ec78796076017a34bfd6908d95b13f2ee6ae05c2cb0d460eed40bc30" }, "downloads": -1, "filename": "deadlinks-0.0.2.tar.gz", "has_sig": false, "md5_digest": "fdd9acb2ec99ef762afd80585c5a7918", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 19524, "upload_time": "2019-10-19T19:14:01", "url": "https://files.pythonhosted.org/packages/97/e6/99de259222547692475c725e1b739a44c8bcdea06c3e7257981ac5b638e8/deadlinks-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c591c64a55b4e10688bb24469b439910", "sha256": "632f7b8545a2cf263de42456a5a385bfb12405bd4f0c25cb51b5f7018cf4f1ca" }, "downloads": -1, "filename": "deadlinks-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "c591c64a55b4e10688bb24469b439910", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 29026, "upload_time": "2019-10-19T19:13:59", "url": "https://files.pythonhosted.org/packages/ba/6f/6828cf167ae840d7ea769b2c2a5e89a2279e7830af48b6c20e57be52cb98/deadlinks-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fdd9acb2ec99ef762afd80585c5a7918", "sha256": "ac66fb68ec78796076017a34bfd6908d95b13f2ee6ae05c2cb0d460eed40bc30" }, "downloads": -1, "filename": "deadlinks-0.0.2.tar.gz", "has_sig": false, "md5_digest": "fdd9acb2ec99ef762afd80585c5a7918", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 19524, "upload_time": "2019-10-19T19:14:01", "url": "https://files.pythonhosted.org/packages/97/e6/99de259222547692475c725e1b739a44c8bcdea06c3e7257981ac5b638e8/deadlinks-0.0.2.tar.gz" } ] }