conviso-cli


Nameconviso-cli JSON
Version 2.2.36 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2025-03-11 16:32:32
maintainerConviso
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
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.8",
    "maintainer_email": "development@convisoappsec.com",
    "keywords": null,
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/c4/c6/68479d91cfdf8921ebfbbe34d359cdea151178b011f6ff8d7d0e43acfc90/conviso-cli-2.2.36.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\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "2.2.36",
    "project_urls": {
        "Source": "https://github.com/convisoappsec/convisocli/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e59ca1e8b2e4a491c7fac36ff75a7141553df3deda062e9f6952dc50cf7de99b",
                "md5": "531549318dfa512255e72f0540c630d8",
                "sha256": "fe7655b50896b877e777b9e632f6e3de2a839af13fd56a4d2b28df991745b934"
            },
            "downloads": -1,
            "filename": "conviso_cli-2.2.36-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "531549318dfa512255e72f0540c630d8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 110678,
            "upload_time": "2025-03-11T16:32:30",
            "upload_time_iso_8601": "2025-03-11T16:32:30.583649Z",
            "url": "https://files.pythonhosted.org/packages/e5/9c/a1e8b2e4a491c7fac36ff75a7141553df3deda062e9f6952dc50cf7de99b/conviso_cli-2.2.36-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c4c668479d91cfdf8921ebfbbe34d359cdea151178b011f6ff8d7d0e43acfc90",
                "md5": "2433b460b502ebb7fd8a1c36ed679645",
                "sha256": "912e37562565c6b66d294c2bf5a7600e6e057a138b59b172e5940c85af494a6a"
            },
            "downloads": -1,
            "filename": "conviso-cli-2.2.36.tar.gz",
            "has_sig": false,
            "md5_digest": "2433b460b502ebb7fd8a1c36ed679645",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 70897,
            "upload_time": "2025-03-11T16:32:32",
            "upload_time_iso_8601": "2025-03-11T16:32:32.070561Z",
            "url": "https://files.pythonhosted.org/packages/c4/c6/68479d91cfdf8921ebfbbe34d359cdea151178b011f6ff8d7d0e43acfc90/conviso-cli-2.2.36.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-11 16:32:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "convisoappsec",
    "github_project": "convisocli",
    "github_not_found": true,
    "lcname": "conviso-cli"
}
        
Elapsed time: 3.90130s