Feature Enhancement - Class-Based Structure and argparse Integration

[TreWilkinsRC]

Summary

Enabling Surveyor usage from both the command line and environments such as Jupyter notebooks with in-script arguments offers greater flexibility and convenience. This pull request aims to refactor Surveyor by introducing a class-based structure and replacing the click library with argparse. This enhancement enhances Surveyor's versatility, empowering users to perform efficient security assessments and promote collaborative, automated analysis workflows.

Benefits

• Seamless integration into existing workflows
• Automated analysis and customizable assessments
• Easier collaboration and streamlined workflow
• Increased adoption and user engagement

Changes Made

• Introduced a class-based structure for better organization
• Replaced the click library with argparse for improved argument handling
• Maintained CLI functionality by passing arguments to the new Surveyor class for processing

Checklist

• [x] Updated the class-based structure for Surveyor
• [x] Replaced click library with argparse
• [x] Ensured CLI functionality is maintained
• [x] Tested changes in both command line and Jupyter notebook environments
• [x] Updated documentation to reflect changes
• [ ] Added relevant unit tests for the new class-based structure

Could use some help rewriting the unit tests

Related Issues

Closes #127

[jholtmann]

This looks great! With these changes it would also be fairly simple to restructure the project into a package that could be published to PyPi. That'd make it easier to use the project in notebooks and other contexts that natively support loading packages from the package index. We'd need to leave surveyor.py in place to avoid breaking compatibility for users that currently check out the repository manually.