Skip to content

Latest commit

 

History

History
33 lines (30 loc) · 1.29 KB

README.md

File metadata and controls

33 lines (30 loc) · 1.29 KB
Raw

Haystack CLI Link Checker

Do you have valid and broken links that need to be fixed? Haystack will find those needles and report them back to you!

Features

Haystack Running

  • Version and help section
  • Coloured terminal text
  • Exception handling for unkown links
  • Support for UNIX and Windows style commands
  • Support for parallelization, using multiple threads pool

Installing Haystack Using PyPI

# To install Haystack with pip, type:
python -m pip install --index-url https://test.pypi.org/simple/ --no-deps haystack-rjayroso

Running Haystack

# Once you have successfully installed Python and the dependencies: 
# Type haystack.py to see help section
python haystack.py

# To see the version, use the argument -v or --version
python haystack.py -v

# To run haystack on your own text file
python haystack.py -f <filename>

# To run haystack on your own HTML file
python haystack.py -u <URL>

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

I would like to thank my colleagues for reviewing my code and issuing suggestions for improvements.