https://github.com/khushiyant/quasarpy

Quasar is python package that can be used for smell detection along with detailed report in various formats
https://github.com/khushiyant/quasarpy

docker radon smell-detector tensorflow

Last synced: 6 months ago
JSON representation

Quasar is python package that can be used for smell detection along with detailed report in various formats

• Host: GitHub
• URL: https://github.com/khushiyant/quasarpy
• Owner: Khushiyant
• License: gpl-3.0
• Created: 2023-11-17T19:56:06.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-26T19:12:23.000Z (over 1 year ago)
• Last Synced: 2025-04-05T16:03:11.935Z (7 months ago)
• Topics: docker, radon, smell-detector, tensorflow
• Language: Python
• Homepage: https://khushiyant.github.io/quasarpy/
• Size: 2.5 MB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
![quasar-logo](https://raw.githubusercontent.com/Khushiyant/quasarpy/8346dfd09733a5e8a6c72018a011a128afabcc34/assets/logo_complete_svg.svg)

## Overview

![GitHub](https://img.shields.io/github/license/Khushiyant/quasar?&style=for-the-badge)

![Python](https://img.shields.io/badge/Made%20With%20Python-lightblue?logo=python&&style=for-the-badge&logoColor=black)

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](#overview)

- [Installation](#installation)

- [Usage](#usage)

  - [Installation](#installation)

  - [Command Line Interface](#command-line-interface)

    - [Arguments](#arguments)

- [Contributing](#contributing)

    - [Versioning](#versioning)

- [License](#license)

## Usage

### Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install quasarpy.

```bash

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](https://huggingface.co/). You can use two of the following ways to setup the token:

- Using the `.env` file

```bash

mv .env.example .env

```

- Using the command Line

```bash

export HUGGINGFACE_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:

```bash

quasar detect --path  --format  --output 

```

#### 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](http://semver.org/) for versioning the package releases.

## License

This project is licensed under the GPL License - see the [LICENSE](https://github.com/Khushiyant/quasarpy/blob/164bc8d8ddfa32f8228fc886871b5a24429c61bb/LICENSE) file for details