Metadata-Version: 2.1
Name: deadlinks
Version: 0.0.2
Summary: CLI/API for links liveness checking.
Home-page: https://github.com/butuzov/deadlinks
Author: Oleg Butuzov
Author-email: butuzov@made.ua
License: Apache License 2.0
Description: [![PyPI](https://img.shields.io/pypi/v/deadlinks)](https://pypi.org/project/deadlinks/)
        [![Travis (.org)](https://img.shields.io/travis/butuzov/deadlinks/master)](https://travis-ci.org/butuzov/deadlinks)
        [![codecov](https://codecov.io/gh/butuzov/deadlinks/branch/master/graph/badge.svg)](https://codecov.io/gh/butuzov/deadlinks)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/cff8901ed5974425a61dff833f8f81b8)](https://codacy.com/manual/butuzov/deadlinks)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/deadlinks)
        ![PyPI - License](https://img.shields.io/pypi/l/deadlinks?color=%23ecac1b)
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/deadlinks)](https://pypi.org/project/deadlinks/)
        ---
        
        **deadlinks** is a simple cli tool to check your documentation/website for deadlinks.
        
        ## Features
        
        -   Concurrent and recursive checks
        -   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
        ```
        
        ### 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
        
        # if you using Python 3.5 on the mac, install new version of pip
        curl https://bootstrap.pypa.io/get-pip.py | python3.5
        # if you using other version, just upgrade pip
        pip install --upgrade pip
        
        # in case if you developing within forked repository
        cd /home/user/deadlinks-fork
        pip install -r requirments.txt
        pip install -e .
        ```
        
        ## Usage
        
        See more examples at [docs](https://github.com/butuzov/deadlinks/blob/develop/docs/examples.md)
        
        ```bash
        # run 10 instances of crawler against https://gobyexample.com.ua
        # with the additional check for the external links (except ones that
        # match play.golang.org)
        deadlinks https://gobyexample.com.ua -n 10 -e -d play.golang.org
        
        # get more help with
        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!
        
        ## Alternatives
        
        These 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:
        
        | Platform           | Title                      | Link                                                                |
        |--------------------|----------------------------|---------------------------------------------------------------------|
        | `mac`, `ui`        | Integrity                  | <https://peacockmedia.software/mac/integrity/free.html>             |
        | `win`, `ui`        | Xenu's Link Sleuth         | <http://home.snafu.de/tilman/xenulink.html>                         |
        | `web`              | Online Broken Link Checker | <https://www.brokenlinkcheck.com/>                                  |
        | `web`              | Free Broken Link Tool      | <https://www.deadlinkchecker.com/website-dead-link-checker.asp>     |
        | `win`, `ui`        | InterroBot                 | <https://interro.bot/>                                              |
        | `go`, `cli`        | muffet                     | <https://github.com/raviqqe/muffet>                                 |
        | `cli`, `ui`, `web` | linkchecker                | <https://wummel.github.io/linkchecker>                              |
        
Keywords: documentation,website,spider,crawler,link-checker
Platform: MacOS
Platform: Posix
Platform: Unix
Classifier: Environment :: Console
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Utilities
Classifier: Topic :: Documentation
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Natural Language :: English
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: lint
Provides-Extra: all
