| Name | quasarpy JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | None |
| Summary | Quasar is python package that can be used for smell detection along with detailed report in various formats such as html, pdf, etc. |
| upload_time | 2024-05-02 16:51:37 |
| maintainer | None |
| docs_url | None |
| author | Khushiyant |
| requires_python | <4.0,>=3.10 |
| license | GPL-3.0-or-later |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## 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](#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
```
### 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 <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](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
Raw data
{
"_id": null,
"home_page": null,
"name": "quasarpy",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Khushiyant",
"author_email": "khushiyant2002@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/46/b5/d4f49d37cef19db2a5b2d9678013e7c39366a480ef621482f0963bdea20c/quasarpy-0.2.2.tar.gz",
"platform": null,
"description": "\n## Overview\n\n\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```\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 <path_to_project> --format <format-output> --output <path_to_output_file>\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",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Quasar is python package that can be used for smell detection along with detailed report in various formats such as html, pdf, etc.",
"version": "0.2.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "171845db8fdf4ca83247846f86cad746b75919b3c9398479005dc851c36ab2e4",
"md5": "7340eca770bf94c5e3e685f99528eb46",
"sha256": "dc6b7f1ae689cfbbf9ec896dac6f340eda7bc73707e4b3780fa686f01ac458d0"
},
"downloads": -1,
"filename": "quasarpy-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7340eca770bf94c5e3e685f99528eb46",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 40449,
"upload_time": "2024-05-02T16:51:36",
"upload_time_iso_8601": "2024-05-02T16:51:36.062940Z",
"url": "https://files.pythonhosted.org/packages/17/18/45db8fdf4ca83247846f86cad746b75919b3c9398479005dc851c36ab2e4/quasarpy-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46b5d4f49d37cef19db2a5b2d9678013e7c39366a480ef621482f0963bdea20c",
"md5": "0b2c205678400c54789796b4a1130c5d",
"sha256": "5d2a6648680e0f88d7fc356f6467c571c347554e45997ba7db3e44e3cb0e9692"
},
"downloads": -1,
"filename": "quasarpy-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "0b2c205678400c54789796b4a1130c5d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 2198773,
"upload_time": "2024-05-02T16:51:37",
"upload_time_iso_8601": "2024-05-02T16:51:37.768014Z",
"url": "https://files.pythonhosted.org/packages/46/b5/d4f49d37cef19db2a5b2d9678013e7c39366a480ef621482f0963bdea20c/quasarpy-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 16:51:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "quasarpy"
}
