pyanchor 0.4

Check you site for broken links!

PyAnchor

Dead links are an annoyance for websites with an extensive amount of content. A side from the negative impact on SEO, dead links are an annoyance for any user that clicks on one.

PyAnchor is primarily for checking the HTTP response on all links on a page. You can integrate it into your development workflow so that users never see a 404 in the first place.

Install

PyAnchor requires Python 3.6 and above.

MacOS / Linux:

$ python3 -m pip install pyanchor

Windows:

> python -m pip install pyanchor

Using the CLI

The CLI can be invoked with the pyanchor command. A URL must be provided.

Basic example for a single page:

> pyanchor https://mysite.com/

Note: all provided URLs must include a valid HTTP scheme.

If you want to check all links on a website, and not just a single page, a sitemap.xml URL may be provided and flagged with --sitemap.

Example:

> pyanchor https://mysite.com/sitemap.xml --sitemap

By default, successful requests are not printed to the terminal. To see all urls with a 200 response add the --verbose flag.

> pyanchor https://mysite.com/sitemap.xml --sitemap --verbose

But wait, there's more...

To integrate PyAnchor into your application, you can import the LinkResults class. LinkResults requires a URL.

Example:

>>> from pyanchor.link_checker import LinkResults
>>> r = LinkResults("https://mysite.com/")
>>> r.results
{200: ["https://mysite.com/about/", "https://mysite.com/contact/"], 500: ["https://mysite.com/doh!/"]}

As you can see the results attribute is a dictionary containing all response codes returned as a dictionary key, with a list of URLs that achieve that response code as the dictionary value.

What's next?

The plan for PyAnchor is to add further analysis of anchor tags, such as missing attributes and security considerations.

After that, who knows? 🤷‍♂️

Feedback

If you find a bug, please file an issue.

If you have feature requests, please file an issue and use the appropriate label.

Support

If you would like to show your support for the project, I would be very grateful if you would donate to a charity close to my heart, Walk AS One.

And if you would prefer to donate to me personally instead, you can sponsor me on Github? 🤓

Contributors

Thank you to:

• Icelain for PR #11
• wevnasc for PR #8
• muditshamz for PR #6