fix: add docstrings to all Python files and remove ruff.toml

Remove root-level ruff.toml; pass lint rules via prek.toml args instead.
Add proper docstrings to vmm-cli.py, ct_monitor.py, add-spdx-attribution.py,
and app.py to comply with pydocstyle rules.

Author: kvinwang

prek.toml

@@ -39,7 +39,7 @@ pass_filenames = false
 repo = "https://github.com/astral-sh/ruff-pre-commit"
 rev = "v0.11.4"
 hooks = [
-    { id = "ruff", args = ["--fix"] },
+    { id = "ruff", args = ["--fix", "--select", "E,F,I,D", "--ignore", "D203,D213,E501"] },
     { id = "ruff-format" },
 ]
 

python/ct_monitor/ct_monitor.py

@@ -1,6 +1,7 @@
 # SPDX-FileCopyrightText: © 2024 Phala Network <dstack@phala.network>
 #
 # SPDX-License-Identifier: Apache-2.0
+"""Monitor certificate transparency logs for a given domain."""
 
 import argparse
 import sys
@@ -15,22 +16,29 @@
 
 
 class PoisonedLog(Exception):
+    """Indicate a poisoned certificate transparency log entry."""
+
     pass
 
 
 class Monitor:
+    """Monitor certificate transparency logs for a domain."""
+
     def __init__(self, domain: str):
+        """Initialize the monitor with a validated domain."""
         if not self.validate_domain(domain):
             raise ValueError("Invalid domain name")
         self.domain = domain
         self.last_checked = None
 
     def get_logs(self, count: int = 100):
+        """Fetch recent certificate transparency log entries."""
         url = f"{BASE_URL}/?q={self.domain}&output=json&limit={count}"
         response = requests.get(url)
         return response.json()
 
     def check_one_log(self, log: object):
+        """Fetch and inspect a single certificate log entry."""
         log_id = log["id"]
         cert_url = f"{BASE_URL}/?d={log_id}"
         cert_data = requests.get(cert_url).text
@@ -68,6 +76,7 @@ def check_one_log(self, log: object):
             print("No valid certificate found in the response.")
 
     def check_new_logs(self):
+        """Check for new log entries since the last check."""
         logs = self.get_logs(count=10000)
         print("num logs", len(logs))
         for log in logs:
@@ -80,6 +89,7 @@ def check_new_logs(self):
             self.last_checked = logs[0]["id"]
 
     def run(self):
+        """Run the monitor loop indefinitely."""
         print(f"Monitoring {self.domain}...")
         while True:
             try:
@@ -93,7 +103,7 @@ def run(self):
 
     @staticmethod
     def validate_domain(domain: str):
-        # ensure domain is a valid DNS domain
+        """Validate that the given string is a well-formed DNS domain name."""
         import re
 
         # Regular expression for validating domain names
@@ -108,6 +118,7 @@ def validate_domain(domain: str):
 
 
 def main():
+    """Parse arguments and start the certificate transparency monitor."""
     parser = argparse.ArgumentParser(
         description="Monitor certificate transparency logs"
     )

ruff.toml

@@ -2,11 +2,10 @@
 # SPDX-FileCopyrightText: © 2025 Phala Network <dstack@phala.network>
 #
 # SPDX-License-Identifier: Apache-2.0
-"""
-SPDX Header Attribution Script
+"""SPDX header attribution script.
 
-This script automatically analyzes git blame data to determine contributors
-and adds appropriate SPDX-FileCopyrightText headers using the REUSE tool.
+Analyze git blame data to determine contributors and add appropriate
+SPDX-FileCopyrightText headers using the REUSE tool.
 
 Features:
 - Excludes third-party code based on .spdx-exclude patterns
@@ -27,7 +26,10 @@
 
 
 class SPDXAttributor:
+    """Add SPDX attribution headers to source files based on git blame."""
+
     def __init__(self, repo_root: str, dry_run: bool = False):
+        """Initialize the attributor with a repository root and options."""
         self.repo_root = Path(repo_root).resolve()
         self.dry_run = dry_run
         self.exclude_patterns = self._load_exclude_patterns()
@@ -491,6 +493,7 @@ def find_source_files(self) -> List[Path]:
 
 
 def main():
+    """Parse arguments and run SPDX attribution on source files."""
     parser = argparse.ArgumentParser(
         description="Add SPDX attribution headers to source files"
     )

scripts/add-spdx-attribution.py

@@ -3,8 +3,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-"""
-Mock Cloudflare DNS API Server
+"""Mock Cloudflare DNS API server.
 
 A mock server that simulates Cloudflare's DNS API for testing purposes.
 Supports the following endpoints used by certbot:
@@ -66,7 +65,7 @@ def get_current_time():
 
 
 def verify_auth(f):
-    """Decorator to verify Bearer token authentication."""
+    """Verify Bearer token authentication."""
 
     @wraps(f)
     def decorated(*args, **kwargs):