mahiuha / alx-checker Goto Github PK

ALX Checker is a simple command-line tool that allows you to check the validity of ALX School projects. ALX School is a project-based software engineering school, and this tool helps to ensure that your projects meet the required guidelines before submission.

• Checks the project structure to ensure it meets ALX School requirements.
• Verifies the presence of mandatory files and directories in the project.
• Scans for common issues in the code, such as syntax errors or formatting problems.
• Provides a detailed report of any detected issues with suggestions for resolution.

• Python 3.6 or higher must be installed on your system.

1. Clone this repository to your local machine:

git clone https://github.com/Mahiuha/alx-checker.git

2. Change into the project directory:

cd alx-checker

3. Install the required Python packages:

pip install -r requirements.txt

1. Navigate to your ALX School project directory.

2. Run the ALX Checker:

python alx_checker.py

The tool will analyze your project and display any issues found along with suggested solutions. Follow the recommendations to ensure your project meets the ALX School standards.

Contributions to the ALX Checker project are welcomed and encouraged! If you find any bugs, have feature requests, or want to improve the tool, please open an issue or submit a pull request. Be sure to follow the project's coding standards and conventions.

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

ALX Checker was inspired by the need to streamline the project validation process for ALX School students. Special thanks to the ALX School community for their support and feedback. Your contributions and suggestions have been invaluable in shaping this tool.