PyVulnerabilityLookup/README.md
Raphaël Vinot 2e26d60150
Some checks failed
Python application - MyPy / Python ${{ matrix.python-version }} sample (3.9) (push) Has been cancelled
Python application - MyPy / Python ${{ matrix.python-version }} sample (3.10) (push) Has been cancelled
Python application - MyPy / Python ${{ matrix.python-version }} sample (3.11) (push) Has been cancelled
Python application - MyPy / Python ${{ matrix.python-version }} sample (3.12) (push) Has been cancelled
Python application - MyPy / Python ${{ matrix.python-version }} sample (3.8) (push) Has been cancelled
new: very basic documentation
2024-07-19 14:34:28 +02:00

31 lines
679 B
Markdown

# Python client and module for Vulnerability Lookup
## Installation
```bash
pip install pyvulnerabilitylookup
```
## Usage
### Command line
You can use the `vulnerability_lookup` command:
```bash
$ vulnerability_lookup -h
usage: vulnerability_lookup [-h] --url URL (--redis_up | --vulnerability VULNERABILITY)
Query a thing.
options:
-h, --help show this help message and exit
--url URL URL of the instance.
--redis_up Check if redis is up.
--vulnerability VULNERABILITY
Get a vulnerability.
```
### Library
See [API Reference](https://pyvulnerabilitylookup.readthedocs.io/en/latest/api_reference.html)