Installation

Prerequisites

Before installing Code Quality Analyzer, ensure you have:

• Python 3.10 or higher

• pip or uv package manager

Installation Methods

From PyPI

Install the published package directly:

# with uv (installs the analyze_code_quality command globally)
uv tool install code-quality-analyzer

# or with pip
pip install code-quality-analyzer

Using uv (Recommended, from source)

uv is the recommended way to install and manage the project:

git clone https://github.com/KarthikShivasankar/python_smells_detector.git
cd python_smells_detector
uv sync

For development (includes sphinx, pytest, and other dev tools):

uv sync --extra dev

Using pip

git clone https://github.com/KarthikShivasankar/python_smells_detector.git
cd python_smells_detector
pip install -e .

Development Installation

For development, install with additional dependencies:

pip install -e ".[dev]"