CodeLint

CodeLint is a lightweight Python module that ensures your code complies with PEP 8 standards. By identifying common issues like long lines, incorrect indentation, inconsistent naming conventions, and unnecessary whitespace, CodeLint helps you write clean, professional, and maintainable Python code.

Table of Contents

Key Features

• Line Length Check: Flags lines exceeding a specified maximum length.
• Indentation Check: Detects incorrect visual indentation (e.g., mixed tabs and spaces).
• Snake Case Check: Ensures variable and function names follow the snake_case naming convention.
• Whitespace Check: Identifies trailing whitespace and excessive blank lines.

Installation

Install CodeLint easily using pip:

pip install codelint

Usage

CodeLint can be run directly from the terminal to analyze Python files for PEP 8 violations.

Command:

codelint <file.py>

Example:

>> pip install codelint
>> codelint my_script.py

Running Tests with Pytest

CodeLint includes comprehensive tests to ensure functionality and reliability. Follow these steps to run the test suite:

1. Clone the repository:

   git clone https://github.com/Aditya-1998k/CodeLint.git
   

2. Navigate to the project directory:

   cd CodeLint
   

3. Install pytest:

   pip install pytest
   

4. Run the tests:

   pytest tests/test_checker.py
   

Example:

How It Works

CodeLint scans your Python files for the following issues:

• Line Length: Checks for lines that exceed the standard maximum length (default is 79 characters).
• Indentation: Ensures consistent indentation (e.g., no mixing of tabs and spaces).
• Snake Case Naming: Verifies that function and variable names adhere to PEP 8's snake_case standard.
• Trailing Whitespace: Identifies and flags any trailing spaces at the end of lines.
• Excessive Blank Lines: Warns about more than one consecutive blank line.

Contributing

We welcome contributions from the community! To contribute:

1. Fork the repository.
2. Create a new branch for your feature:

   git checkout -b feature-name
   

3. Commit your changes:

   git commit -m "Add feature-name"
   

4. Push to your branch:

   git push origin feature-name
   

5. Submit a pull request.

License

CodeLint is licensed under the MIT License. See the LICENSE file for details.

CodeLint helps you maintain high coding standards effortlessly. Install today and ensure your Python projects adhere to best practices! 🚀