setup.py

# Copyright (C) 2021 Intel Corporation
# SPDX-License-Identifier: GPL-3.0-or-later

import ast
import os
import pathlib
import re

from setuptools import find_packages, setup

PACKAGE_ROOT_PATH = pathlib.Path(__file__).parent.resolve()

with open("README.md", encoding="utf-8") as f:
    readme = f.read()

with open("requirements.txt", encoding="utf-8") as f:
    requirements = f.read().split("\n")

with open(os.path.join("cve_bin_tool", "version.py")) as f:
    for line in f:
        if line.startswith("VERSION"):
            VERSION = ast.literal_eval(line.strip().split("=")[-1].strip())
            break


def enumerate_entry_points_parsers():
    """Reads the files in cve_bin_tool/parsers/to auto determine list"""
    parsers = {}
    for path in PACKAGE_ROOT_PATH.joinpath(
        "cve_bin_tool",
        "parsers",
    ).glob("*.py"):
        if "__init__" == path.stem:
            continue
        contents = path.read_text()
        for re_match in re.finditer(r"^class (\w+)", contents, re.MULTILINE):
            parser_cls_name = re_match[1]
            parsers[".".join([path.stem, parser_cls_name])] = ":".join(
                [
                    str(path.relative_to(PACKAGE_ROOT_PATH).with_suffix("")).replace(
                        os.path.sep, "."
                    ),
                    parser_cls_name,
                ],
            )
    return parsers


setup_kwargs = dict(
    name="cve-bin-tool",
    version=VERSION,
    description="CVE Binary Checker Tool",
    long_description=readme,
    long_description_content_type="text/markdown",
    author="Terri Oda",
    author_email="terri.oda@intel.com",
    maintainer="Terri Oda",
    maintainer_email="terri.oda@intel.com",
    url="https://github.com/intel/cve-bin-tool",
    license="GPL-3.0-or-later",
    keywords=["security", "tools", "CVE"],
    python_requires=">=3.8",
    classifiers=[
        "Development Status :: 5 - Production/Stable",
        "Intended Audience :: Developers",
        "License :: OSI Approved :: GNU General Public License (GPL)",
        "Natural Language :: English",
        "Operating System :: OS Independent",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Programming Language :: Python :: Implementation :: CPython",
        "Programming Language :: Python :: Implementation :: PyPy",
    ],
    install_requires=requirements,
    extras_require={
        "PDF": ["reportlab"],
    },
    packages=find_packages(
        exclude=["locales", "presentation"],
    ),
    package_data={
        "cve_bin_tool.output_engine": [
            "html_reports/templates/*.html",
            "html_reports/css/*.css",
            "html_reports/js/*.js",
            "print_mode/templates/*.html",
        ],
        "cve_bin_tool": [
            "schemas/*.xsd",
        ],
        "sbom": ["*.spdx", "*.json"],
    },
    entry_points={
        "console_scripts": [
            "cve-bin-tool = cve_bin_tool.cli:main",
            "csv2cve = cve_bin_tool.csv2cve:main",
        ],
        "cve_bin_tool.checker": [
            "{} = cve_bin_tool.checkers.{}:{}".format(
                filename.replace(".py", ""),
                filename.replace(".py", ""),
                "".join(
                    (filename.replace(".py", "") + " checker")
                    .replace("_", " ")
                    .title()
                    .split()
                ),
            )
            for filename in os.listdir(
                os.path.join(
                    os.path.abspath(os.path.dirname(__file__)),
                    "cve_bin_tool",
                    "checkers",
                )
            )
            if filename.endswith(".py") and "__init__" not in filename
        ],
        "cve_bin_tool.parsers": [
            "{} = {}".format(
                parser_entry_point_name,
                entry_point_path,
            )
            for (
                parser_entry_point_name,
                entry_point_path,
            ) in enumerate_entry_points_parsers().items()
        ],
    },
)

if __name__ == "__main__":
    setup(**setup_kwargs)