updates/refactoring related to PR#16

Author: nocomplexity

docs/examples/ca_api_example_basic.ipynb

@@ -1,6 +1,3 @@
 # SPDX-FileCopyrightText: 2025-present Maikel Mardjan - https://nocomplexity.com/
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
-from importlib.metadata import version
-
-__version__ = version("codeaudit")

src/codeaudit/__init__.py

@@ -19,12 +19,12 @@
 import platform
 from collections import Counter
 from pathlib import Path
+from importlib.metadata import version
 
 import altair as alt
 import pandas as pd
 
 
-from codeaudit import __version__
 from codeaudit.checkmodules import (
     check_module_vulnerability,
     get_all_modules,
@@ -48,9 +48,9 @@
 )
 
 
-def version():
+def version_info():
     """Returns the version of Python Code Audit"""
-    ca_version = __version__
+    ca_version = version("codeaudit")
     return {"name": "Python_Code_Audit", "version": ca_version}
 
 
@@ -113,7 +113,7 @@ def filescan(input_path, nosec=False):
     """
     file_output = {}
     file_path = Path(input_path)
-    ca_version_info = version()
+    ca_version_info = version_info()
     now = datetime.datetime.now()
     timestamp_str = now.strftime("%Y-%m-%d %H:%M")
     output = ca_version_info | {"generated_on": timestamp_str}
@@ -403,7 +403,7 @@ def get_default_validations():
 
 def _generation_info():
     """Internal function to retrieve generation info for APIs output"""
-    ca_version_info = version()
+    ca_version_info = version_info()
     now = datetime.datetime.now()
     timestamp_str = now.strftime("%Y-%m-%d %H:%M")
     output = ca_version_info | {"generated_on": timestamp_str}

src/codeaudit/api_interfaces.py

@@ -14,18 +14,20 @@
 """
 
 import sys
+from importlib.metadata import version
 
 import fire  # for working CLI with this PoC-thing (The Google way)
 
-from codeaudit import __version__
-
 from codeaudit.reporting import (
     overview_report,
     report_implemented_tests,
     report_module_information,
     scan_report,
 )
 
+
+CA_VERSION = version("codeaudit")
+
 codeaudit_ascii_art = r"""
 ----------------------------------------------------
  _                    __             _             
@@ -37,7 +39,7 @@
 
 def display_version():
     """Prints the module version. Or use codeaudit [-v] [--v] [-version] or [--version]."""
-    print(f"version: {__version__}")
+    print(f"version: {CA_VERSION}")
 
 
 def display_help():

src/codeaudit/codeaudit.py

@@ -16,10 +16,10 @@
 import datetime
 import re
 from importlib.resources import files
+from importlib.metadata import version
 from pathlib import Path
 
-# from codeaudit.api_interfaces import version
-from codeaudit import __version__
+
 from codeaudit.filehelpfunctions import (
     collect_python_source_files,
     get_filename_from_path,
@@ -63,7 +63,7 @@ def data_egress_scan(input_path):
     """
     file_output = {}
     file_path = Path(input_path)
-    ca_version_info = {"name": "Python_Code_Audit", "version": __version__}
+    ca_version_info = {"name": "Python_Code_Audit", "version": version("codeaudit")}
     now = datetime.datetime.now()
     timestamp_str = now.strftime("%Y-%m-%d %H:%M")
     output = ca_version_info | {"generated_on": timestamp_str}

src/codeaudit/privacy_lint.py

@@ -21,10 +21,12 @@
 from urllib.error import HTTPError, URLError
 from urllib.request import Request, urlopen
 
-from codeaudit import __version__
+from importlib.metadata import version
+
+CA_VERSION = version("codeaudit")
 
 NOCX_HEADERS = {
-    "user-agent": f"Python Code Audit /{__version__} (https://github.com/nocomplexity/codeaudit)",
+    "user-agent": f"Python Code Audit /{CA_VERSION} (https://github.com/nocomplexity/codeaudit)",
     "Accept": "text/html, application/xhtml+xml, application/xml;q=0.9, */*;q=0.8",
     "Accept-Encoding": "gzip, deflate,br",
     "Connection": "keep-alive",

src/codeaudit/pypi_package_scan.py

@@ -18,6 +18,8 @@
 from pathlib import Path
 import sys
 
+from importlib.metadata import version
+
 import pandas as pd
 import html
 import datetime
@@ -44,14 +46,16 @@
     get_imported_modules_by_file,
 )
 from codeaudit.htmlhelpfunctions import json_to_html, dict_list_to_html_table
-from codeaudit import __version__
+
 from codeaudit.pypi_package_scan import get_pypi_download_info, get_package_source
 from codeaudit.privacy_lint import data_egress_scan, has_privacy_findings
 from codeaudit.suppression import filter_sast_results
 from codeaudit.api_interfaces import _collect_issue_lines
 
 from importlib.resources import files
 
+CA_VERSION = version("codeaudit")
+
 PYTHON_CODE_AUDIT_TEXT = '<a href="https://github.com/nocomplexity/codeaudit" target="_blank"><b>Python Code Audit</b></a>'
 DISCLAIMER_TEXT = (
     "<p><b>Disclaimer:</b> <i>This SAST tool "
@@ -769,7 +773,7 @@ def create_htmlfile(html_input, outputfile):
 
     now = datetime.datetime.now()
     timestamp_str = now.strftime("%Y-%m-%d %H:%M")
-    code_audit_version = __version__
+    code_audit_version = CA_VERSION
 
     output += (
         f"<p>This Python security report was created on: <b>{timestamp_str}</b> with "
@@ -806,64 +810,6 @@ def create_htmlfile(html_input, outputfile):
     print("=====================================================================\n")
 
 
-# def create_htmlfile(html_input,outputfile):
-#     """ Creates a clean html file based on html input given """
-#     # Read CSS from the file - So it is included in the reporting HTML file
-
-#     with open(SIMPLE_CSS_FILE, 'r') as css_file:
-#         css_content = css_file.read()
-#     # Start building the HTML
-#     output = '<!DOCTYPE html><html lang="en-US"><head>'
-#     output += '<meta charset="UTF-8"/>'
-#     output += '<title>Python_Code_Audit_SecurityReport</title>'
-#     # Inline CSS inside <style> block
-#     output += f'<style>\n{css_content}\n</style>'
-#     output += '<script src="https://cdn.jsdelivr.net/npm/vega@5"></script>' # needed for altair plots
-#     output += '<script src="https://cdn.jsdelivr.net/npm/vega-lite@5"></script>' # needed for altair plots
-#     output += '<script src="https://cdn.jsdelivr.net/npm/vega-embed@6"></script>' # needed for altair plots
-#     output += '</head><body>'
-#     output += '<div class="container">'
-#     output += html_input
-#     now = datetime.datetime.now()
-#     timestamp_str = now.strftime("%Y-%m-%d %H:%M")
-#     code_audit_version = __version__
-#     output += (
-#         f"<p>This Python security report was created on: <b>{timestamp_str}</b> with "
-#         + PYTHON_CODE_AUDIT_TEXT
-#         + f" version <b>{code_audit_version}</b></p>"
-#     )
-#     output += '<hr>'
-#     output += '<footer>'
-#     output += (
-#         '<div class="footer-links">'
-#         'Check the <a href="https://nocomplexity.com/documents/codeaudit/intro.html" '
-#         'target="_blank">documentation</a> for help on found issues.<br>'
-#         'Codeaudit is made with <span class="heart">&#10084;</span> by cyber security '
-#         'professionals who advocate for <a href="https://nocomplexity.com/simplify-security/" target="_blank">open simple security solutions</a>.<br>'
-#         '<a href="https://nocomplexity.com/documents/codeaudit/CONTRIBUTE.html" target="_blank">Join the community</a> and contribute to make this tool better!'
-#         "</div>"
-#     )
-#     output += "</footer>"
-#     output += '</div>' #base container
-#     output += '</body></html>'
-#     # Now create the HTML output file
-#     with open(outputfile, 'w') as f:
-#         f.write(output)
-#     current_directory = os.getcwd()
-#     # Get the directory of the output file (if any)
-#     directory_for_output = os.path.dirname(os.path.abspath(outputfile))
-#     filename_only = os.path.basename(outputfile)
-#     # Determine the effective directory to use in the file URL
-#     if not directory_for_output or directory_for_output == current_directory:
-#         file_url = f'file://{current_directory}/{filename_only}'
-#     else:
-#         file_url = f'file://{directory_for_output}/{filename_only}'
-#     # Print the result
-#     print("\n=====================================================================")
-#     print(f'Code Audit report file created!\nPaste the line below directly into your browser bar:\n\t{file_url}\n')
-#     print("=====================================================================\n")
-
-
 def extract_altair_html(plot_html):
     match = re.search(r"<body[^>]*>(.*?)</body>", plot_html, re.DOTALL | re.IGNORECASE)
     if match:
@@ -955,7 +901,7 @@ def report_implemented_tests(filename=DEFAULT_OUTPUT_FILE):
     number_of_test = len(df_checks)
 
     output += df_checks_sorted.to_html(escape=False, index=False)
-    code_audit_version = __version__
+    code_audit_version = CA_VERSION
     output += "<br>"
     output += (
         f"<p>Number of implemented security validations:<b>{number_of_test}</b></p>"