Metadata-Version: 2.1
Name: pyvariot
Version: 0.2.0
Summary: Python CLI and module to query the VARIoT IoT vulnerabilities and exploits databases
Home-page: https://github.com/cve-search/pyvariot
License: BSD-3-Clause
Author: Raphaël Vinot
Author-email: raphael.vinot@circl.lu
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet
Classifier: Topic :: Security
Provides-Extra: docs
Requires-Dist: Sphinx (>=7.3.7,<8.0.0) ; extra == "docs"
Requires-Dist: requests (>=2.32.3,<3.0.0)
Project-URL: Documentation, https://pyvariot.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/cve-search/pyvariot
Description-Content-Type: text/markdown

# Python client and module to query the VARIoT IoT vulnerabilities and exploits databases

This is a Python client and module to query the [VARIoT IoT vulnerabilities and exploits databases](https://www.variotdbs.pl/api/).

## Installation

```bash
pip install pyvariot
```

## Usage

### Command line

You can use the `pyvariot` command to query the database:

```bash
$ pyvariot --help
usage: pyvariot [-h] [--url URL] [--apikey APIKEY]
                (--vulnerability_id VULNERABILITY_ID | --exploit_id EXPLOIT_ID)

Get a vulnerability or an exploit by ID.

options:
  -h, --help            show this help message and exit
  --url URL             URL of the instance.
  --apikey APIKEY       Your personal API key.
  --vulnerability_id VULNERABILITY_ID
                        ID of the vulnerability.
  --exploit_id EXPLOIT_ID
                        ID of the exploit.

```

### Library

See [API Reference](https://pyvariot.readthedocs.io/en/latest/api_reference.html)

