Metadata-Version: 2.1
Name: existence
Version: 0.3.0
Summary: Checks static .html files for bad links
Home-page: https://github.com/ckcollab/existence
Author: Eric Carmichael
Author-email: eric@ckcollab.com
License: MIT
Description: existence
        =========
        
        Recursively scans directories for static html files for bad or empty links. See
        [here](http://www.ericcarmichael.com/writing-my-first-python-package.html) why I wrote this, I hate missing details!
        
        # Example bad or empty links
        
        ```html
        <a href=""></a>            Empty
        <a href></a>               Empty
        <a href="python.org"></a>  Any bad link will fail, this one is missing http://
        ```
        
        ## Command line
        
            $ existence /path/to/working/links
            Checking links...
            57 of 57
            All of your links exist!
        
            $ existence /path/to/bad/links
            Checking links...
            23 of 23
            Broken links:
                /path/to/bad/links/index.html@121 'None'
                /path/to/bad/links/other.html@22 'non-existant.html'
        
        ## Python
        
        ```python
        >>> from existence import scan
        >>> scan("/path/to/working/links")
        []
        >>> scan("/path/to/bad/links")
        [
            ('None', '/path/to/bad/links/index.html', 121),
            ('non-existant.html', '/path/to/bad/links/other.html', 22)
        ]
        # Returns a list of bad url tuples: [(url, file_name, line_number)]
        ```
        
        # Progress bar
        
        To enable the progress bar `pip install progressbar==2.3`
        
        
        # Running tests
        
            > python -m unittest discover
        
        # Deploying new release
        
        ```bash
        $ python setup.py sdist
        $ ```
Keywords: link checker
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
