djcheckup 0.2.3__tar.gz → 0.2.5__tar.gz

{djcheckup-0.2.3 → djcheckup-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: djcheckup
-Version: 0.2.3
+Version: 0.2.5
 Summary: DJ Checkup is a security scanner for Django sites.
 Author: Stuart Maxwell
 Author-email: Stuart Maxwell <stuart@amanzi.nz>

{djcheckup-0.2.3 → djcheckup-0.2.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "djcheckup"
-version = "0.2.3"
+version = "0.2.5"
 description = "DJ Checkup is a security scanner for Django sites."
 readme = "README.md"
 authors = [{ name = "Stuart Maxwell", email = "stuart@amanzi.nz" }]
@@ -26,14 +26,17 @@ target-version = "py313"
 [tool.ruff.lint]
 select = ["ALL"]
 
+[tool.pyrefly]
+project-includes = ["src/djcheckup/**"]
+
 [tool.ruff.lint.extend-per-file-ignores]
-"tests/**" = ["S101", "ANN201", "ANN001", "ARG001"]
+"tests/**" = ["S101", "ANN201", "ANN001", "ARG001", "PT011", "PGH003", "SLF001"]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google" # Accepts: "google", "numpy", or "pep257".
 
 [dependency-groups]
-dev = ["nox>=2025.5.1", "pytest>=8.4.2", "pytest-cov>=7.0.0"]
+dev = ["nox>=2025.5.1", "pyrefly>=0.34.0", "pytest>=8.4.2", "pytest-cov>=7.0.0"]
 
 [tool.pytest.ini_options]
 pythonpath = "."
@@ -44,7 +47,7 @@ show_contexts = true
 
 [tool.coverage.run]
 branch = true
-include = ["src/djcheckup/*"]
+include = ["src/djcheckup/**"]
 
 [tool.coverage.report]
 # exclude_lines = ["if TYPE_CHECKING:", "# pragma: no cover"]

{djcheckup-0.2.3 → djcheckup-0.2.5}/src/djcheckup/checks.py

@@ -1,6 +1,7 @@
 """Check types."""
 
 from abc import ABC, abstractmethod
+from collections.abc import Sequence
 from dataclasses import dataclass
 from enum import Enum
 from http.cookiejar import CookieJar
@@ -389,8 +390,15 @@ class SiteChecker:
             message=success_message,
         )
 
-    def run_checks(self, checks: list[_BaseCheck]) -> SiteCheckResult:
-        """Run all checks."""
+    def run_checks(self, checks: Sequence[_BaseCheck]) -> SiteCheckResult:
+        """Run all checks.
+
+        Args:
+            checks: Accepts any sequence (list, tuple, etc.) of check instances inheriting from _BaseCheck.
+
+        Returns:
+            A SiteCheckResult object containing the results of all checks.
+        """
         # First, run the first check
         first_check = self.run_first_check()
         site_check_results = SiteCheckResult(url=str(self.url), check_results=[first_check])

{djcheckup-0.2.3 → djcheckup-0.2.5}/src/djcheckup/cli.py

@@ -22,14 +22,10 @@ def run_checks(
     ] = False,
 ) -> None:
     """Run the DJ Checkup tool against a specific URL."""
-    checker = SiteChecker(url)
+    checker = SiteChecker(url=url)
     results = checker.run_checks(all_checks)
 
     if output_json:
         rich.print_json(output_results_as_json(results))
     else:
         rich_output(results)
-
-
-if __name__ == "__main__":
-    app()

{djcheckup-0.2.3 → djcheckup-0.2.5}/src/djcheckup/outputs.py

@@ -25,10 +25,13 @@ def rich_output(check_results: SiteCheckResult) -> None:
         emoji = ""
         if result.result == CheckResult.SUCCESS:
             emoji = "🟢 "
-        elif result.result == CheckResult.FAILURE:
+
+        if result.result == CheckResult.FAILURE:
             emoji = "🔴 "
-        elif result.result == CheckResult.SKIPPED:
+
+        if result.result == CheckResult.SKIPPED:
             emoji = "🟡 "
+
         display_result = emoji + result.result.value.capitalize()
         table.add_row(result.name, display_result, Markdown(result.message))
 
@@ -43,8 +46,9 @@ def json_encoder(obj: object) -> str | int:
     if isinstance(obj, CheckResult):
         return obj.value
 
-    msg = f"Object of type {type(obj).__name__} is not JSON serialisable"
-    raise TypeError(msg)
+    # The following should never happen since this encoder is only used for SeverityWeight and CheckResult
+    msg = f"Object of type {type(obj).__name__} is not JSON serialisable"  # pragma: no cover
+    raise TypeError(msg)  # pragma: no cover
 
 
 def output_results_as_json(results: SiteCheckResult) -> str:

djcheckup-0.2.5/src/djcheckup/run.py

@@ -0,0 +1,48 @@
+"""Run the DJ Checkup security scanner."""
+
+from typing import Literal, overload
+
+import httpx
+
+from djcheckup.check_defs import all_checks
+from djcheckup.checks import SiteChecker, SiteCheckResult
+from djcheckup.outputs import output_results_as_json
+
+
+@overload
+def run_checks(
+    url: str,
+    output_format: Literal["object"] = "object",
+    client: httpx.Client | None = None,
+) -> SiteCheckResult: ...
+@overload
+def run_checks(url: str, output_format: Literal["json"], client: httpx.Client | None = None) -> str: ...
+
+
+def run_checks(
+    url: str,
+    output_format: Literal["object", "json"] = "object",
+    client: httpx.Client | None = None,
+) -> str | SiteCheckResult:
+    """Run the DJ Checkup tool.
+
+    Args:
+        url: The URL to check.
+        output_format: The format of the output, either "object" or "json" (default: "object").
+        client: An optional HTTPX client to use for requests.
+
+    Returns:
+        The result of the checks, either as a JSON string or a SiteCheckResult object.
+    """
+    with SiteChecker(url, client=client) as checker:
+        results = checker.run_checks(all_checks)
+
+    if output_format not in {"object", "json"}:
+        msg = f"Invalid output_format: {output_format!r}. Must be 'object' or 'json'."
+        raise ValueError(msg)
+
+    if output_format == "json":
+        return output_results_as_json(results)
+
+    # Default to object output
+    return results

djcheckup-0.2.3/src/djcheckup/run.py

@@ -1,29 +0,0 @@
-"""Run the DJ Checkup security scanner."""
-
-from typing import Literal, overload
-
-from djcheckup.check_defs import all_checks
-from djcheckup.checks import SiteChecker, SiteCheckResult
-from djcheckup.outputs import output_results_as_json
-
-
-@overload
-def run_checks(url: str, output_format: Literal["object"] = "object") -> SiteCheckResult: ...
-@overload
-def run_checks(url: str, output_format: Literal["json"]) -> str: ...
-
-
-def run_checks(url: str, output_format: Literal["object", "json"] = "object") -> str | SiteCheckResult:
-    """Run the DJ Checkup tool against a specific URL and returns a JSON string."""
-    with SiteChecker(url) as checker:
-        results = checker.run_checks(all_checks)
-
-    if output_format not in {"object", "json"}:
-        msg = f"Invalid output_format: {output_format!r}. Must be 'object' or 'json'."
-        raise ValueError(msg)
-
-    if output_format == "json":
-        return output_results_as_json(results)
-
-    # Default to object output
-    return str(results)