Move to src layout; remove scripts

Signed-off-by: Henri Rosten <[email protected]>
tiiuae · Nov 28, 2023 · 56a65e4 · 56a65e4
1 parent b2a6739
commit 56a65e4
Show file tree

Hide file tree

Showing 27 changed files with 34 additions and 36 deletions.
diff --git a/nix/devshell.nix b/nix/devshell.nix
@@ -35,7 +35,7 @@
       # (cascading down to the processes it spawns), but this is for the developer
       # invoking entrypoints from inside the devshell.
       shellHook = ''
-        export PYTHONPATH="$PYTHONPATH:$(pwd)"
+        export PYTHONPATH="$PYTHONPATH:$(pwd)/src"
       '';
     };
   };

diff --git a/setup.py b/setup.py
@@ -50,22 +50,16 @@ def project_path(*names):
         "Operating System :: POSIX :: Linux",
         "Programming Language :: Python :: 3 :: Only",
     ],
-    keywords="SBOM",
-    packages=[
-        "sbomnix",
-        "nixgraph",
-        "scripts.vulnxscan",
-        "scripts.nixupdate",
-        "scripts.repology",
-    ],
+    packages=setuptools.find_namespace_packages(where="src"),
+    package_dir={"": "src"},
     entry_points={
         "console_scripts": [
             "sbomnix  = sbomnix.main:main",
             "nixgraph = nixgraph.main:main",
-            "nix_outdated = scripts.nixupdate.nix_outdated:main",
-            "vulnxscan = scripts.vulnxscan.vulnxscan:main",
-            "repology_cli = scripts.repology.repology_cli:main",
-            "repology_cve = scripts.repology.repology_cve:main",
+            "nix_outdated = nixupdate.nix_outdated:main",
+            "vulnxscan = vulnxscan.vulnxscan_cli:main",
+            "repology_cli = repology.repology_cli:main",
+            "repology_cve = repology.repology_cve:main",
         ]
     },
 )
diff --git a/nixgraph/__init__.py → src/common/__init__.py b/nixgraph/__init__.py → src/common/__init__.py
diff --git a/sbomnix/utils.py → src/common/utils.py b/sbomnix/utils.py → src/common/utils.py
diff --git a/sbomnix/__init__.py → src/nixgraph/__init__.py b/sbomnix/__init__.py → src/nixgraph/__init__.py
diff --git a/nixgraph/graph.py → src/nixgraph/graph.py b/nixgraph/graph.py → src/nixgraph/graph.py
@@ -18,7 +18,7 @@
 import pandas as pd
 import graphviz as gv
 
-from sbomnix.utils import (
+from common.utils import (
     LOG,
     LOG_SPAM,
     exec_cmd,

diff --git a/nixgraph/main.py → src/nixgraph/main.py b/nixgraph/main.py → src/nixgraph/main.py
@@ -9,7 +9,7 @@
 import argparse
 import pathlib
 from nixgraph.graph import NixDependencies
-from sbomnix.utils import (
+from common.utils import (
     set_log_verbosity,
     get_py_pkg_version,
     check_positive,

diff --git a/scripts/nixupdate/README.md → src/nixupdate/README.md b/scripts/nixupdate/README.md → src/nixupdate/README.md
diff --git a/scripts/nixupdate/__init__.py → src/nixupdate/__init__.py b/scripts/nixupdate/__init__.py → src/nixupdate/__init__.py
diff --git a/scripts/nixupdate/nix_outdated.py → src/nixupdate/nix_outdated.py b/scripts/nixupdate/nix_outdated.py → src/nixupdate/nix_outdated.py
@@ -15,7 +15,7 @@
 from argparse import ArgumentParser
 from tabulate import tabulate
 from sbomnix.sbomdb import SbomDb
-from sbomnix.utils import (
+from common.utils import (
     LOG,
     LOG_SPAM,
     set_log_verbosity,

diff --git a/scripts/repology/README.md → src/repology/README.md b/scripts/repology/README.md → src/repology/README.md
diff --git a/scripts/repology/__init__.py → src/repology/__init__.py b/scripts/repology/__init__.py → src/repology/__init__.py
diff --git a/scripts/repology/repology_cli.py → src/repology/repology_cli.py b/scripts/repology/repology_cli.py → src/repology/repology_cli.py
@@ -24,7 +24,7 @@
 import numpy as np
 import pandas as pd
 from tabulate import tabulate
-from sbomnix.utils import (
+from common.utils import (
     LOG,
     LOG_SPAM,
     set_log_verbosity,

diff --git a/scripts/repology/repology_cve.py → src/repology/repology_cve.py b/scripts/repology/repology_cve.py → src/repology/repology_cve.py
@@ -20,7 +20,7 @@
 import numpy as np
 import pandas as pd
 from tabulate import tabulate
-from sbomnix.utils import (
+from common.utils import (
     LOG,
     LOG_SPAM,
     set_log_verbosity,

diff --git a/scripts/vulnxscan/__init__.py → src/sbomnix/__init__.py b/scripts/vulnxscan/__init__.py → src/sbomnix/__init__.py
diff --git a/sbomnix/cpe.py → src/sbomnix/cpe.py b/sbomnix/cpe.py → src/sbomnix/cpe.py
@@ -13,7 +13,7 @@
 import shutil
 import requests
 
-from sbomnix.utils import (
+from common.utils import (
     LOG,
     LOG_SPAM,
     df_from_csv_file,

diff --git a/sbomnix/derivation.py → src/sbomnix/derivation.py b/sbomnix/derivation.py → src/sbomnix/derivation.py
@@ -14,7 +14,7 @@
 from packageurl import PackageURL
 from sbomnix.cpe import CPE
 
-from sbomnix.utils import LOG, LOG_SPAM
+from common.utils import LOG, LOG_SPAM
 
 
 ###############################################################################

diff --git a/sbomnix/main.py → src/sbomnix/main.py b/sbomnix/main.py → src/sbomnix/main.py
@@ -9,7 +9,7 @@
 import argparse
 import pathlib
 from sbomnix.sbomdb import SbomDb
-from sbomnix.utils import (
+from common.utils import (
     LOG,
     set_log_verbosity,
     check_positive,

diff --git a/sbomnix/nix.py → src/sbomnix/nix.py b/sbomnix/nix.py → src/sbomnix/nix.py
@@ -10,7 +10,7 @@
 import json
 import pandas as pd
 
-from sbomnix.utils import LOG, LOG_SPAM, exec_cmd
+from common.utils import LOG, LOG_SPAM, exec_cmd
 from sbomnix.derivation import load
 
 ###############################################################################

diff --git a/sbomnix/sbomdb.py → src/sbomnix/sbomdb.py b/sbomnix/sbomdb.py → src/sbomnix/sbomdb.py
@@ -19,7 +19,7 @@
 from reuse._licenses import LICENSE_MAP as SPDX_LICENSES
 from nixgraph.graph import NixDependencies
 from sbomnix.nix import Store, find_deriver
-from sbomnix.utils import LOG, df_to_csv_file, get_py_pkg_version
+from common.utils import LOG, df_to_csv_file, get_py_pkg_version
 
 ###############################################################################
 

diff --git a/scripts/vulnxscan/README.md → src/vulnxscan/README.md b/scripts/vulnxscan/README.md → src/vulnxscan/README.md
diff --git a/src/vulnxscan/__init__.py b/src/vulnxscan/__init__.py
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2022 Technology Innovation Institute (TII)
+#
+# SPDX-License-Identifier: Apache-2.0
diff --git a/scripts/vulnxscan/osv.py → src/vulnxscan/osv.py b/scripts/vulnxscan/osv.py → src/vulnxscan/osv.py
@@ -15,7 +15,7 @@
 import json
 import requests
 import pandas as pd
-from sbomnix.utils import LOG, LOG_SPAM, df_to_csv_file, set_log_verbosity
+from common.utils import LOG, LOG_SPAM, df_to_csv_file, set_log_verbosity
 
 ###############################################################################
 

diff --git a/scripts/vulnxscan/vulnxscan.py → src/vulnxscan/vulnxscan_cli.py b/scripts/vulnxscan/vulnxscan.py → src/vulnxscan/vulnxscan_cli.py
@@ -32,9 +32,9 @@
 import numpy as np
 
 from tabulate import tabulate
-from scripts.vulnxscan.osv import OSV
+from vulnxscan.osv import OSV
 from sbomnix.sbomdb import SbomDb
-from sbomnix.utils import (
+from common.utils import (
     LOG,
     LOG_SPAM,
     set_log_verbosity,

diff --git a/tests/compare_deps.py b/tests/compare_deps.py
@@ -15,7 +15,7 @@
 import pathlib
 import json
 import pandas as pd
-from sbomnix.utils import (
+from common.utils import (
     LOG,
     LOG_SPAM,
     set_log_verbosity,

diff --git a/tests/compare_sboms.py b/tests/compare_sboms.py
@@ -15,7 +15,7 @@
 import pathlib
 import json
 import pandas as pd
-from sbomnix.utils import LOG, df_to_csv_file, set_log_verbosity
+from common.utils import LOG, df_to_csv_file, set_log_verbosity
 
 ###############################################################################
 

diff --git a/tests/test_sbomnix.py b/tests/test_sbomnix.py
@@ -17,11 +17,11 @@
 import jsonschema
 import pytest
 
-from sbomnix.utils import (
+from common.utils import (
     df_from_csv_file,
 )
 
-from scripts.vulnxscan.vulnxscan import (
+from vulnxscan.vulnxscan_cli import (
     load_whitelist,
     df_apply_whitelist,
 )
@@ -35,16 +35,17 @@
 COMPARE_SBOMS = MYDIR / "compare_sboms.py"
 
 REPOROOT = MYDIR / ".."
+SRCDIR = REPOROOT / "src"
 
 # The different entrypoints of the application. Currently we invoke them with a
 # new python interpreter, as it's not in a shape yet to import a function we
 # pass arguments to.
-SBOMNIX = REPOROOT / "sbomnix" / "main.py"
-NIXGRAPH = REPOROOT / "nixgraph" / "main.py"
-NIX_OUTDATED = REPOROOT / "scripts" / "nixupdate" / "nix_outdated.py"
-VULNXSCAN = REPOROOT / "scripts" / "vulnxscan" / "vulnxscan.py"
-REPOLOGY_CLI = REPOROOT / "scripts" / "repology" / "repology_cli.py"
-REPOLOGY_CVE = REPOROOT / "scripts" / "repology" / "repology_cve.py"
+SBOMNIX = SRCDIR / "sbomnix" / "main.py"
+NIXGRAPH = SRCDIR / "nixgraph" / "main.py"
+NIX_OUTDATED = SRCDIR / "nixupdate" / "nix_outdated.py"
+VULNXSCAN = SRCDIR / "vulnxscan" / "vulnxscan_cli.py"
+REPOLOGY_CLI = SRCDIR / "repology" / "repology_cli.py"
+REPOLOGY_CVE = SRCDIR / "repology" / "repology_cve.py"
 
 TEST_WORK_DIR = None
 TEST_NIX_RESULT = None