Py_SH - Python Linter & Error Finder

Py_SH is a powerful Python linter that scans your code for errors, style issues, and potential bugs. It generates comprehensive, easy-to-read reports in JSON format, helping you identify and fix mistakes quickly.

✨ Features

Error Detection: Identifies syntax errors, logical issues, and common mistakes

JSON Reports: Clean, structured output for easy parsing and integration

Fast Analysis: Quick scanning with detailed problem breakdown

Developer Friendly: Clear, actionable error messages

Extensible: Easy to add custom rules and checks

📦 Installation

pip install py-sh-linter

Or clone the repository:

git clone https://github.com/TANYA-sHAKYA/vscode-extension.git
cd py_sh
pip install -r requirements.txt

🚀 Quick Start

Basic Usage

py_sh lint your_script.py
py_sh lint src/

Generate JSON report

py_sh lint your_script.py --json output.json

Command help

usage: py_sh lint [-h] [--json OUTPUT] [--fix] [--verbose] [files...]

positional arguments:
  files                 Files or directories to lint

options:
  -h, --help            show this help message and exit
  --json OUTPUT         Save report as JSON file
  --fix                 Auto-fix simple issues
  --verbose             Show detailed error information

📊 Sample JSON Report

{
  "summary": {
    "total_files": 5,
    "errors": 12,
    "warnings": 8,
    "clean_files": 2
  },
  "files": [
    {
      "path": "main.py",
      "errors": 3,
      "issues": [
        {
          "line": 15,
          "column": 5,
          "type": "syntax_error",
          "message": "Undefined variable 'user_name'",
          "severity": "error",
          "suggestion": "Define 'user_name' before usage"
        }
      ]
    }
  ]
}

🛠️ Development

Prerequisites

• Python 3.10+
• pip and virtualenv

Setup

git clone https://github.com/TANYA-sHAKYA/vscode-extension.git
cd py_sh
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

Running Tests

pytest tests/

Adding New Rules

• Create a new rule file in py_sh/rules/
• Register it in py_sh/linter.py
• Add tests in tests/rules/
• Run pytest to verify

🤝 Contributing

Contributions are welcome! Please:

Fork the repository

Create a feature branch (git checkout -b feature/amazing-feature)

Commit your changes (git commit -m 'Add amazing feature')

Push to the branch (git push origin feature/amazing-feature)

Open a Pull Request

📄 License

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

🙌 Acknowledgments

Created by: Tanya Shakya

Thanks to the Python community for the amazing ecosystem!

📞 Support

For support, email tanyashakya7015@gmail.com or create an issue on GitHub.