README.md

Overview

Quasar is python package that can be used for smell detection along with detailed report in various formats such as html, pdf, etc.

Table of contents

• Overview
• Installation
• Usage
  • Installation
  • Command Line Interface
    • Arguments
• Contributing
  • Versioning
• License

Usage

Installation

Use the package manager pip to install quasarpy.

pip install quasarpy

Since, quasrpy relies on hugging face for its online LLM reference, so it is required to set the environment variable HUGGINGFACE_TOKEN with the value of your hugging face token. You can get the token by signing up on Hugging Face. You can use two of the following ways to setup the token:

• Using the .env file

mv .env.example .env

• Using the command Line

export HUGGINGFACE_TOKEN=<your_token>

Command Line Interface

Quasar can be used as a command line tool to detect smells in a project. The command line interface can be used as follows:

quasar detect --path <path_to_project> --format <format-output> --output <path_to_output_file>

Arguments

• --path : Path to the project directory
• --format : Output format of the report (html, pdf, etc.)
• --output : Path to the output file
• --help : Display help message
• --version : Display version of the package
• --offline : Run the LLM in offline mode/without internet connection (default: False)

Contributing

Versioning

We use Sementic Versioning for versioning the package releases.

License

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