Skip to content

A command-line tool for finding and reporting dead/broken links in a file or webpage.

Notifications You must be signed in to change notification settings

chrispinkney/hes-dead-jim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

He's Dead, Jim

What

He's Dead, Jim is a link checking program, specifically it is a command-line tool for finding and reporting dead links (e.g., broken URLs) in a specified file or website. This tool can be used to help locate broken URLs in an HTML page.

How

He's Dead, Jim aggregates (a fancy word for saying grabs) all href tags on a single page/file and creates get requests for each link on the page. Those requests are then reported back to the user along with the status code and a delightful colour coded message indicating the status of each link.

Why

He's Dead, Jim is a small project developed as part of my introduction to the world of Open Source Development, in addition to Git and GitHub.

This is my project. There are many like it, but this one is mine.

Features

He's Dead Jim features the following optional features:

  • Colourized output. Good URLs are printed in green, bad URLs are printed in red, and unknown URLs in gray.
  • -v can be supplied to the program for current version information.
  • Program incorporates multi-threading to allow for parallelization of the program.

Usage / Installation

Install Python on your machine (Be sure to select Add Python 3.x to PATH when installing) and reboot (optional):

Open a shell/cmd and execute the following commands:

pip install He-s-Dead-Jim

hdj

Contribution

Please be sure to read CONTRIBUTING.md prior to any development. Feel free to make a Pull Request or Issue regarding and functionality and I'll get to it ASAP.

Issues

Current issues in the projects can be found on the repo's issues page.

License

MIT License - A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

About

A command-line tool for finding and reporting dead/broken links in a file or webpage.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages