change: uv ify the project

.gitignore

@@ -1,6 +1,4 @@
-bin/__pycache__/
-lib/__pycache__/
-lib/cpeimport/__pycache__/
+**/__pycache__
 data/*.gz
 data/*.tar
 data/*.json

.python-version

@@ -0,0 +1 @@
+3.13

Dockerfile

@@ -1,18 +1,45 @@
 # syntax=docker/dockerfile:1
 
-FROM python:3.8-slim-buster
+FROM alpine:latest
+
+COPY . /app
+
+RUN <<EOF
+apk update
+apk add py3-pip
+pip install pipx
+pipx install --global uv
+EOF
+
+# Disable development dependencies
+ENV UV_NO_DEV=1
 
 WORKDIR /app
 
-COPY REQUIREMENTS REQUIREMENTS
-RUN pip3 install -r REQUIREMENTS
+RUN uv sync --locked
+
+# configuration
+COPY <<EOF /app/config/settings.yaml
+server:
+  port: 8000
+valkey:
+  host: valkey
+  port: 6379
+  db: 8
+cpe:
+  path: '/data/nvdcpe-2.0.tar'
+  source: 'https://nvd.nist.gov/feeds/json/cpe/2.0/nvdcpe-2.0.tar.gz'
+EOF
+
+# entrypoint script
+COPY <<EOF entrypoint.sh
+#!/bin/ash
+set -e
 
-COPY bin bin
-COPY etc /etc
-COPY lib lib
-COPY docker/entrypoint.sh entrypoint.sh
+uv run cpe-import
+uv run cpe-server
+EOF
 
-RUN mkdir /app/config
 RUN chmod u+x entrypoint.sh
 
-ENTRYPOINT ["/app/entrypoint.sh"]
+ENTRYPOINT ["/app/entrypoint.sh"]

docker/docker-compose.yml → docker-compose.yml

@@ -1,12 +1,10 @@
-version: "3"
 services:
   server:
     container_name: cpe-guesser
     image: cpe-guesser:1.0
     build: ..
     volumes:
       - ../data/:/data/:rw
-      - ./settings.yaml:/app/config/settings.yaml
     ports:
       - 8000:8000
     depends_on:

pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "cpe-guesser"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "dynaconf>=3.2.12",
+    "falcon>=4.2.0",
+    "pydantic>=2.12.5",
+    "spectree>=2.0.1",
+    "valkey[libvalkey]>=6.1.1",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.26,<0.10.0"]
+build-backend = "uv_build"
+
+[project.scripts]
+cpe-import = "cpe_guesser.bin.importer:main"
+cpe-lookup = "cpe_guesser.bin.lookup:main"
+cpe-server = "cpe_guesser.bin.server:main"

lib/cpeguesser.py → src/cpe_guesser/__init__.py

@@ -1,5 +1,5 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+from typing import List, Tuple
 
 import valkey
 from dynaconf import Dynaconf
@@ -20,7 +20,7 @@ def __init__(self):
             decode_responses=True,
         )
 
-    def guessCpe(self, words):
+    def guessCpe(self, words) -> List[Tuple[int, str]]:
         k = []
         for keyword in words:
             k.append(f"w:{keyword.lower()}")
@@ -29,13 +29,12 @@ def guessCpe(self, words):
         cpes = []
         for x in reversed(range(maxinter)):
             ret = self.rdb.sinter(k[x])
-            cpes.append(list(ret))
+            cpes.append(list(ret))  # ty:ignore[invalid-argument-type]
         result = set(cpes[0]).intersection(*cpes)
 
         ranked = []
 
         for cpe in result:
             rank = self.rdb.zrank("rank:cpe", cpe)
             ranked.append((rank, cpe))
-
         return sorted(ranked, reverse=True)

bin/import.py → src/cpe_guesser/bin/importer.py

@@ -1,31 +1,24 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-
 import argparse
-import sys
 import os
-import valkey
+import sys
 import urllib.error
+
+import valkey
 from dynaconf import Dynaconf
+from valkey.client import Valkey
 
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
-from lib.cpeimport import CPEDownloader, NVDCPEHandler, XMLCPEHandler
+from cpe_guesser.cpeimport import CPEDownloader, NVDCPEHandler, XMLCPEHandler
 
-# Configuration
-settings = Dynaconf(settings_files=["../config/settings.yaml"])
-cpe_path = settings.get("cpe.path", "./data/nvdcpe-2.0.tar")
-cpe_source = settings.get(
-    "cpe.source",
-    "https://nvd.nist.gov/feeds/json/cpe/2.0/nvdcpe-2.0.tar.gz",
-)
-valkey_host = settings.get("valkey.host", "127.0.0.1")
-valkey_port = settings.get("valkey.port", 6379)
-valkey_db = settings.get("valkey.db", 8)
 
-rdb = valkey.Valkey(host=valkey_host, port=valkey_port, db=valkey_db)
+def dbsize(rdb: Valkey) -> int:
+    dbsize = rdb.dbsize()
+    if isinstance(dbsize, int):
+        return dbsize
+    return 0
 
 
-if __name__ == "__main__":
+def main():
     argparser = argparse.ArgumentParser(
         description="Initializes the Redis database with CPE dictionary."
     )
@@ -45,7 +38,20 @@
     )
     args = argparser.parse_args()
 
-    if not args.replace and rdb.dbsize() > 0:
+    # Configuration
+    settings = Dynaconf(settings_files=["../config/settings.yaml"])
+    cpe_path = settings.get("cpe.path", "./data/nvdcpe-2.0.tar")
+    cpe_source = settings.get(
+        "cpe.source",
+        "https://nvd.nist.gov/feeds/json/cpe/2.0/nvdcpe-2.0.tar.gz",
+    )
+    valkey_host = settings.get("valkey.host", "127.0.0.1")
+    valkey_port = settings.get("valkey.port", 6666)
+    valkey_db = settings.get("valkey.db", 8)
+
+    rdb = valkey.Valkey(host=valkey_host, port=valkey_port, db=valkey_db)
+
+    if not args.replace and dbsize(rdb) > 0:
         print(f"Warning! The Redis database already has {rdb.dbsize()} keys.")
         print("Use --replace if you want to flush the database and repopulate it.")
         sys.exit(0)
@@ -60,13 +66,14 @@
             FileNotFoundError,
             PermissionError,
         ) as e:
+            print(f"Error: {e}")
             sys.exit(1)
 
     elif os.path.isfile(cpe_path):
         print(f"Using existing file {cpe_path} ...")
         cpe_file = cpe_path
 
-    if rdb.dbsize() > 0 and args.replace:
+    if rdb.dbsize() > 0 and args.replace:  # ty:ignore[unsupported-operator]
         print(f"Flushing {rdb.dbsize()} keys from the database...")
         rdb.flushdb()
 
@@ -87,3 +94,7 @@
     handler.parse_file(cpe_file, label=label)
 
     print(f"Done! {rdb.dbsize()} keys inserted.")
+
+
+if __name__ == "__main__":
+    main()

bin/lookup.py → src/cpe_guesser/bin/lookup.py

@@ -1,16 +1,12 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 import argparse
-import os
-import sys
 import json
 
-runPath = os.path.dirname(os.path.realpath(__file__))
-sys.path.append(os.path.join(runPath, ".."))
-from lib.cpeguesser import CPEGuesser
+from cpe_guesser import CPEGuesser
 
-if __name__ == "__main__":
+
+def main():
     parser = argparse.ArgumentParser(
         description="Find potential CPE names from a list of keyword(s) and return a JSON of the results"
     )
@@ -30,12 +26,18 @@
     args = parser.parse_args()
 
     cpeGuesser = CPEGuesser()
-    r = cpeGuesser.guessCpe(args.word)
+    cpes = cpeGuesser.guessCpe(args.word)
+
     if not args.unique:
-        print(json.dumps(r))
+        print(json.dumps(cpes))
     else:
-        try:
-            r = r[:1][0][1]
-        except:
-            r = []
+        r = []
+        if len(cpes) > 0:
+            if len(cpes[0]) >= 2:
+                cpes = cpes[0][1]
+
         print(json.dumps(r))
+
+
+if __name__ == "__main__":
+    main()

bin/server.py → src/cpe_guesser/bin/server.py

@@ -1,22 +1,19 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-import os
+import json
 import sys
-import falcon
 from wsgiref.simple_server import make_server
-import json
+
+import falcon
 from dynaconf import Dynaconf
 
+from cpe_guesser import CPEGuesser
+
 # Configuration
 settings = Dynaconf(settings_files=["../config/settings.yaml"])
 port = settings.get("server.port", 8000)
 
-runPath = os.path.dirname(os.path.realpath(__file__))
-sys.path.append(os.path.join(runPath, ".."))
-
-from lib.cpeguesser import CPEGuesser
-
 
 class Search:
     def on_post(self, req, resp):
@@ -59,14 +56,17 @@ def on_post(self, req, resp):
             return
 
         cpeGuesser = CPEGuesser()
-        try:
-            r = cpeGuesser.guessCpe(q["query"])[:1][0][1]
-        except:
-            r = []
+        cpes = cpeGuesser.guessCpe(q["query"])[:1][0][1]
+
+        r = []
+        if len(cpes) > 0:
+            if len(cpes[0]) >= 2:
+                r = cpes[0][1]
+
         resp.media = r
 
 
-if __name__ == "__main__":
+def main():
     app = falcon.App()
     app.add_route("/search", Search())
     app.add_route("/unique", Unique())
@@ -80,3 +80,7 @@ def on_post(self, req, resp):
         sys.exit(1)
     except KeyboardInterrupt:
         sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()