| Name | conviso-cli JSON |
| Version |
2.5.6
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2025-07-18 22:21:37 |
| maintainer | Conviso |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CLI
This is a command line tool to interact with [convisoappsec] API.
# Documentation
Please visit the [official documentation] for further information.
[official documentation]: <https://docs.convisoappsec.com/cli/installation>
# Development Mode
To run this application in development mode, follow these steps:
## 1. Clone the Repository
First, clone this repository:
```shell
git clone <repository_url>
cd convisocli
```
## Set Up Python Environment
Create and activate a virtual environment:
```shell
python -m venv venv
source venv/bin/activate # On macOS/Linux
venv\Scripts\activate # On Windows
```
and then install in development mode:
```shell
pip install -e .
```
### Using pyenv:
If you don't have pyenv installed, follow the installation guide:
https://github.com/pyenv/pyenv?tab=readme-ov-file#installation
```shell
pyenv install 3.13.1
```
To set a version only for convisocli, go to convisocli directory and run:
```shell
pyenv local 3.13.1
```
To set a python version globally:
```shell
pyenv global 3.13.1
```
and then you can run:
```shell
pip install -e .
```
To install convisocli.
Run the following command to check if convisocli is installed correctly:
```shell
conviso --help
```
To run the tests, install the required dependencies by running:
```shell
pip install -r dev_requirements.txt
```
Once installed, execute the tests with:
```shell
pytest
```
To run tests with coverage report:
```shell
pytest --cov=convisoappsec test/
```
Raw data
{
"_id": null,
"home_page": null,
"name": "conviso-cli",
"maintainer": "Conviso",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "development@convisoappsec.com",
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/12/65/423efb50f2992e09359efd5eb325408e9fcc9d42e635d683322a8fae051f/conviso_cli-2.5.6.tar.gz",
"platform": null,
"description": "# CLI\n\nThis is a command line tool to interact with [convisoappsec] API. \n\n# Documentation\nPlease visit the [official documentation] for further information.\n\n[official documentation]: <https://docs.convisoappsec.com/cli/installation>\n\n# Development Mode\n\nTo run this application in development mode, follow these steps:\n\n## 1. Clone the Repository\n\nFirst, clone this repository:\n\n```shell\ngit clone <repository_url>\ncd convisocli\n```\n\n## Set Up Python Environment\nCreate and activate a virtual environment:\n```shell\n python -m venv venv\n source venv/bin/activate # On macOS/Linux\n venv\\Scripts\\activate # On Windows\n\n```\nand then install in development mode:\n```shell\n pip install -e .\n```\n\n### Using pyenv:\n\nIf you don't have pyenv installed, follow the installation guide:\nhttps://github.com/pyenv/pyenv?tab=readme-ov-file#installation\n\n```shell\n pyenv install 3.13.1\n```\n\nTo set a version only for convisocli, go to convisocli directory and run:\n```shell\n pyenv local 3.13.1\n```\n\nTo set a python version globally:\n\n```shell\n pyenv global 3.13.1\n```\n\nand then you can run:\n```shell\n pip install -e .\n```\nTo install convisocli.\n\nRun the following command to check if convisocli is installed correctly:\n\n```shell\n conviso --help\n```\n\nTo run the tests, install the required dependencies by running:\n\n```shell\n pip install -r dev_requirements.txt\n```\n\nOnce installed, execute the tests with:\n\n```shell\n pytest\n```\n\nTo run tests with coverage report:\n\n```shell\n pytest --cov=convisoappsec test/\n```\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "2.5.6",
"project_urls": {
"Source": "https://github.com/convisoappsec/convisocli/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "62c0228764850a5830d99bbb36be2c1c646b2092046379f0241872be9587209e",
"md5": "2fb46a5bd1ea3a050ec09e752ba9a1e0",
"sha256": "9ba400c444ee351ec659d75f9ebd4c3a8200ce75d99e06a67dfdf13ce6b6b3d7"
},
"downloads": -1,
"filename": "conviso_cli-2.5.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fb46a5bd1ea3a050ec09e752ba9a1e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 108960,
"upload_time": "2025-07-18T22:21:36",
"upload_time_iso_8601": "2025-07-18T22:21:36.190575Z",
"url": "https://files.pythonhosted.org/packages/62/c0/228764850a5830d99bbb36be2c1c646b2092046379f0241872be9587209e/conviso_cli-2.5.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1265423efb50f2992e09359efd5eb325408e9fcc9d42e635d683322a8fae051f",
"md5": "7237b561e159c11efa43675787489213",
"sha256": "9a189d506a507592058aa3c2c4958c3973eb10868c3689c39255332c70042ad9"
},
"downloads": -1,
"filename": "conviso_cli-2.5.6.tar.gz",
"has_sig": false,
"md5_digest": "7237b561e159c11efa43675787489213",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 68416,
"upload_time": "2025-07-18T22:21:37",
"upload_time_iso_8601": "2025-07-18T22:21:37.735788Z",
"url": "https://files.pythonhosted.org/packages/12/65/423efb50f2992e09359efd5eb325408e9fcc9d42e635d683322a8fae051f/conviso_cli-2.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 22:21:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "convisoappsec",
"github_project": "convisocli",
"github_not_found": true,
"lcname": "conviso-cli"
}
