Metadata-Version: 2.1
Name: pyhtmlproofer
Version: 0.2.3.alpha
Summary: pyHtmlProofer - A tool for validating internal & external links in HTML files / Websites
License: MIT
Author-email: Rehan Haider <email@rehanhaider.com>
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# pyHTMLProofer

Check for website and static HTML pages for link rot.


## Features

pyHTMLProofer can be used on
1. Static HTML pages (typically generated by an SSG). You can specify either files or directories to be checked.
2. Webpages, you can specify a URL/link to be checked.


pyHTMLProofer at the moment does the following:

1. Checks for broken internal links in HTML files
2. Checks if external links in HTML or website link are valid

You can read more details below in [What's Tested?](#whats-tested) section.

### Roadmap
The follower features are under development:
1. Check for scripts / stylesheets in HTML files
2. Check for images and alt-text in HTML files
3. Check entire website using Sitemap


## Installation
TBD


## What's tested?

You can configure pyHTMLProofer to check:

- a file
- a directory or list of directories
- a URL / Link


`a` elements: PyHTMLProofer checks - 

- If the internal links are valid
- If the internal references (`#in-page-links`) are valid
- If the external links are valid

## Usage
TBD

## Available Config Options
TBD


## Real-Life examples:
TBD



## Credits

The inspiration was by Ruby based [HTMLProofer](https://github.com/gjtorikian/html-proofer) and lack of Python based alternatives. Although, [pyHTMLProofer](https://github.com/rehanhaider/pyhtmlproofer) is not a Python rewrite, instead it focuses on solving problems that I encountered while maintaining [CloudBytes/Dev>](https://cloudbytes.dev) website.
