Giter Club home page Giter Club logo

quasarpy's Introduction

quasar-logo

Overview

GitHub Python

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

Usage

Installation

Use the package manager pip to install quasarpy.

pip install quasarpy

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

quasarpy's People

Contributors

khushiyant avatar hitesh22rana avatar

Stargazers

 avatar  avatar Aniket avatar

Watchers

Kostas Georgiou avatar  avatar

quasarpy's Issues

Integrate `sourcecollector` for Efficient Source Code Consolidation

Is your feature request related to a problem? Please describe.
The current data preparation step for gathering and consolidating multiple source code files from various repositories is time-consuming. This process often involves manually collecting files, which is not only inefficient but also increases the risk of errors, ultimately hindering the workflow and delaying the training of models for smell detection.

Describe the solution you'd like
I propose integrating sourcecollector into the Quasar project. sourcecollector is a tool designed to consolidate multiple files into a single .txt file, streamlining the process of collecting source code from various repositories. This integration would enhance the efficiency of data preparation, allowing Quasar to easily gather and process large amounts of source code for training its smell detection models.

Describe alternatives you've considered
An alternative solution would be to manually gather and consolidate the source code files or develop a custom script to perform this task. However, these methods are less efficient and more error-prone compared to using a dedicated tool like sourcecollector.

Additional context
For more details on sourcecollector, you can visit the GitHub repository: https://github.com/hitesh22rana/sourcecollector. Integrating this tool could significantly reduce the time and effort required for preparing source code data, thereby enhancing the overall functionality and performance.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.