Python library for downloading CVE and CPE from NIST NVD
Project description
greenbone-scap - Python library for downloading CVE and CPE from NIST NVD
The greenbone-scap Python package is a collection of utilities and tools to download the CPE and CVE information from the NIST NVD REST API into a PostgreSQL database.
Table of Contents
Installation
Requirements
Python 3.11 and later is supported.
Install using pipx
You can install the latest stable release of greenbone-scap from the Python Package Index (pypi) using pipx
python3 -m pipx install greenbone-scap
Install using pip
[!NOTE] The
pip install
command does no longer work out-of-the-box in newer distributions like Ubuntu 23.04 because of PEP 668. Please use the installation via pipx instead.
You can install the latest stable release of greenbone-scap from the Python Package Index (pypi) using pip
python3 -m pip install --user greenbone-scap
Command Completion
greenbone-scap
comes with support for command line completion in bash and zsh.
All greenbone-scap CLI commands support shell completion. As examples the
following sections explain how to set up the completion for greenbone-cve-download
with bash and zsh.
Setup for bash
echo "source ~/.greenbone-cve-download-complete.bash" >> ~/.bashrc
greenbone-cve-download --print-completion bash > ~/.greenbone-cve-download-complete.bash
Alternatively, you can use the result of the completion command directly with the eval function of your bash shell:
eval "$(greenbone-cve-download --print-completion bash)"
Setup for zsh
echo 'fpath=("$HOME/.zsh.d" $fpath)' >> ~/.zsh
mkdir -p ~/.zsh.d/
greenbone-cve-download --print-completion zsh > ~/.zsh.d/_greenbone_cve_download
Alternatively, you can use the result of the completion command directly with the eval function of your zsh shell:
eval "$(greenbone-cve-download --print-completion zsh)"
Development
greenbone-scap uses poetry for its own dependency management and build process.
First install poetry via pipx
python3 -m pipx install poetry
Afterwards run
poetry install
in the checkout directory of greenbone-scap (the directory containing the
pyproject.toml
file) to install all dependencies including the packages only
required for development.
Afterwards activate the git hooks for auto-formatting and linting via autohooks.
poetry run autohooks activate
Validate the activated git hooks by running
poetry run autohooks check
Maintainer
This project is maintained by Greenbone AG
Contributing
Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.
License
Copyright (C) 2024 Greenbone AG
Licensed under the GNU General Public License v3.0 or later.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for greenbone_scap-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc7cb41dacedcd1dd5d6eca0aeaa3cc44458ba8bee8ba5013bb5f9027137730b |
|
MD5 | eab9554420c3f09fc82efc3fca34f8f1 |
|
BLAKE2b-256 | cb21fd8c24f27123710421cdf1388c4c0791e976c6a13ca5bdc643241a5cc829 |