Metadata-Version: 2.1
Name: conviso-cli
Version: 2.3.0.dev4
Summary: UNKNOWN
Maintainer: Conviso
Maintainer-email: development@convisoappsec.com
License: UNKNOWN
Project-URL: Source, https://github.com/convisoappsec/convisocli/
Platform: UNKNOWN
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: GitPython<4,>=3.1.2
Requires-Dist: click<8,>=7.1.2
Requires-Dist: requests==2.31.0
Requires-Dist: urllib3==2.2.0
Requires-Dist: semantic-version<3,>=2.8.5
Requires-Dist: docker<=6.1.3
Requires-Dist: PyYAML==6.0.1
Requires-Dist: click-log<1,>=0.3.2
Requires-Dist: transitions<1,>=0.8.7
Requires-Dist: jsonschema<3,>=2.5.1
Requires-Dist: giturlparse<=0.12.0
Requires-Dist: jmespath<1.0.1,>=0.9.0
Requires-Dist: setuptools==69.2.0

# 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/
```


