Implemented CLI Interface to pose it as a tool rather than a "script", Error Handling, Logging, Banner Realtime Contributor Display in PhishKiller

[asheshjyotii]

Overview

This pull request introduces comprehensive enhancements to the PhishKiller tool, focusing on the CLI interface, error handling, logging, and real-time contributor display. The updates aim to improve usability, design, and overall user experience while recognizing the efforts of key contributors.

Key Contributions:

1. Enhanced CLI Interface:

   • Added a visually appealing ASCII banner logo.
   • Improved user prompts and interface design for better usability and aesthetics.
   • Enhanced color schemes and layout to make the tool more user-friendly.

2. Improved Error Handling and Logging:

   • Implemented robust error handling mechanisms to manage network and data processing errors effectively.
   • Set up a logging configuration to save logs to a file, providing better traceability and debugging capabilities.

3. Real-Time Top Contributor Display:

   • Added functionality to fetch and display the top 5 contributors from the GitHub repository using the GitHub API.
   • Implemented a fallback mechanism to load contributor information from a local JSON file in case of network issues or API request failures.

4. Documentation Updates:

   • Updated the README to reflect the new features and improvements for enhanced usability.
   • Added a CONTRIBUTING file to provide guidelines for future contributors.

     Benefits:

• User Experience: The improved CLI interface and enhanced error handling provide a professional and engaging user experience.
• Recognition: Displaying top contributors dynamically highlights the efforts of key maintainers, fostering community recognition and involvement.
• Robustness: Improved logging and error handling mechanisms ensure the tool is more reliable and easier to debug.

How to Test:

1. Clone the repository and switch to the cli-interface branch.

2. Run the PhishKiller tool and observe the enhanced CLI interface and real-time top contributor display.

   
   git clone https://github.com/CybrZone/phishkiller
   cd phishkiller
   pip install -r requirements.txt
   python3 run.py

Additional Notes:

• Ensure that the local JSON file src/utils/contrib.json is present for the fallback mechanism to work correctly.
• The GitHub API rate limit may affect the ability to fetch contributor information if the limit is exceeded.

I believe these enhancements will significantly improve the usability, design, and community engagement of the PhishKiller tool. Thank you @CybrZone for considering this pull request.