{"id":16980990,"url":"https://github.com/khushiyant/quasarpy","last_synced_at":"2025-04-12T02:20:19.877Z","repository":{"id":207830826,"uuid":"720199073","full_name":"Khushiyant/quasarpy","owner":"Khushiyant","description":"Quasar is python package that can be used for smell detection along with detailed report in various formats","archived":false,"fork":false,"pushed_at":"2024-05-26T19:12:23.000Z","size":2620,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T16:03:11.935Z","etag":null,"topics":["docker","radon","smell-detector","tensorflow"],"latest_commit_sha":null,"homepage":"https://khushiyant.github.io/quasarpy/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Khushiyant.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["Khushiyant"]}},"created_at":"2023-11-17T19:56:06.000Z","updated_at":"2024-05-26T19:12:01.000Z","dependencies_parsed_at":"2024-05-14T08:52:41.546Z","dependency_job_id":null,"html_url":"https://github.com/Khushiyant/quasarpy","commit_stats":null,"previous_names":["khushiyant/quasar","khushiyant/quasarpy"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Khushiyant%2Fquasarpy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Khushiyant%2Fquasarpy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Khushiyant%2Fquasarpy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Khushiyant%2Fquasarpy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Khushiyant","download_url":"https://codeload.github.com/Khushiyant/quasarpy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248505921,"owners_count":21115354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","radon","smell-detector","tensorflow"],"created_at":"2024-10-14T02:04:19.812Z","updated_at":"2025-04-12T02:20:19.843Z","avatar_url":"https://github.com/Khushiyant.png","language":"Python","funding_links":["https://github.com/sponsors/Khushiyant"],"categories":[],"sub_categories":[],"readme":"![quasar-logo](https://raw.githubusercontent.com/Khushiyant/quasarpy/8346dfd09733a5e8a6c72018a011a128afabcc34/assets/logo_complete_svg.svg)\n## Overview\n![GitHub](https://img.shields.io/github/license/Khushiyant/quasar?\u0026style=for-the-badge)\n![Python](https://img.shields.io/badge/Made%20With%20Python-lightblue?logo=python\u0026\u0026style=for-the-badge\u0026logoColor=black)\n\nQuasar is python package that can be used for smell detection along with detailed report in various formats such as html, pdf, etc. \n\n# Table of contents\n\n- [Overview](#overview)\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Installation](#installation)\n  - [Command Line Interface](#command-line-interface)\n    - [Arguments](#arguments)\n- [Contributing](#contributing)\n    - [Versioning](#versioning)\n- [License](#license)\n\n## Usage\n\n### Installation\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install quasarpy.\n\n```bash\npip install quasarpy\n```\nSince, 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:\n\n- Using the `.env` file\n\n```bash\nmv .env.example .env\n\n```\n\n- Using the command Line\n\n```bash\nexport HUGGINGFACE_TOKEN=\u003cyour_token\u003e\n```\n\n### Command Line Interface\n\nQuasar can be used as a command line tool to detect smells in a project. The command line interface can be used as follows:\n\n\n```bash\nquasar detect --path \u003cpath_to_project\u003e --format \u003cformat-output\u003e --output \u003cpath_to_output_file\u003e\n```\n#### Arguments\n\n- `--path` : Path to the project directory\n- `--format` : Output format of the report (html, pdf, etc.)\n- `--output` : Path to the output file\n- `--help` : Display help message\n- `--version` : Display version of the package\n- `--offline` : Run the LLM in offline mode/without internet connection (default: False)\n\n\n### Contributing\n\n#### Versioning\n\nWe use [Sementic Versioning](http://semver.org/) for versioning the package releases.\n\n## License\n\nThis project is licensed under the GPL License - see the [LICENSE](https://github.com/Khushiyant/quasarpy/blob/164bc8d8ddfa32f8228fc886871b5a24429c61bb/LICENSE) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhushiyant%2Fquasarpy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhushiyant%2Fquasarpy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhushiyant%2Fquasarpy/lists"}