RMPR / broken_link_checker

Check the broken links on a website.

Broken Link Checker

Check the broken links on a website.

Why?

Websites usually have many external links on their pages, and there is no way to know if an external has changed. The author is notified about the issue that happens when a visitor messages him about the broken link. It would be great to have something that does the job for you, and the only thing you have to do is update the link to a valid one. I currently have this issue on my personal blog.

Description

This project aims to build a Web service that takes the URL, browse all the website pages to retrieve hyperlinks, and check if they are broken or not. When the verification is completed, the author will receive an email with all the broken links that need an update. It will be possible to schedule the frequency to check broken links on a website. The service should be easily configurable and deployable.

Labels

This is a console project that will run as a cron job.

Running the Project Locally

For normal usage

README

For developer only

First, clone the repository to your local machine:

git clone https://github.com/osscameroon/broken_link_checker.git

Create a virtual env:

NB: Compatibility Python3.10+

python3 -m venv blc_venv

Active the virtual env:

source blc_venv/bin/activate

Install dependencies:

make install-deps

Build the package:

make build

For the next step confer normal usage

If you want run the tests, use this command

make test

License

MIT