woolly 0.3.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

woolly/reporters/template.py

@@ -0,0 +1,245 @@
+"""
+Template-based report generator using Jinja2.
+
+Allows users to provide a custom markdown template file for report generation.
+Only a limited set of variables are exposed for security and simplicity.
+"""
+
+from pathlib import Path
+from typing import Optional
+
+from woolly.reporters.base import ReportData, Reporter, strip_markup
+
+
+class TemplateReporter(Reporter):
+    """Reporter that generates reports from user-provided Jinja2 templates.
+
+    This reporter allows users to customize the output format by providing
+    a markdown template file. Only a limited, safe set of variables are
+    exposed to the template.
+
+    Available template variables:
+        Metadata:
+            - root_package: Name of the analyzed package
+            - language: Language/ecosystem name (e.g., "Rust", "Python")
+            - registry: Registry name (e.g., "crates.io", "PyPI")
+            - root_license: License of the root package (or None)
+            - version: Package version (if specified)
+            - timestamp: Formatted timestamp string (YYYY-MM-DD HH:MM:SS)
+            - max_depth: Maximum recursion depth used
+
+        Statistics:
+            - total_dependencies: Total number of dependencies analyzed
+            - packaged_count: Number of packages available in Fedora
+            - missing_count: Number of packages missing from Fedora
+
+        Optional dependency statistics:
+            - include_optional: Whether optional deps were included
+            - optional_total: Total optional dependencies
+            - optional_packaged: Optional deps available in Fedora
+            - optional_missing: Optional deps missing from Fedora
+
+        Dev/Build dependency statistics:
+            - dev_total, dev_packaged, dev_missing: Dev dep counts
+            - build_total, build_packaged, build_missing: Build dep counts
+            - dev_dependencies: List of dev dep dicts with Fedora status
+            - build_dependencies: List of build dep dicts with Fedora status
+
+        Features / Extras:
+            - features: List of feature/extra objects with name and dependencies
+
+        Package lists (sorted):
+            - missing_packages: List of missing required package names
+            - packaged_packages: List of packaged package names
+            - optional_missing_packages: List of missing optional package names
+
+        Flags:
+            - missing_only: Whether missing-only mode was enabled
+
+    Example template:
+        # Report for {{ root_package }}
+
+        Generated: {{ timestamp }}
+        Language: {{ language }}
+
+        ## Summary
+        - Total: {{ total_dependencies }}
+        - Packaged: {{ packaged_count }}
+        - Missing: {{ missing_count }}
+
+        {% if missing_packages %}
+        ## Missing Packages
+        {% for pkg in missing_packages %}
+        - {{ pkg }}
+        {% endfor %}
+        {% endif %}
+    """
+
+    name = "template"
+    description = "Custom template-based report (requires --template)"
+    file_extension = "md"
+    writes_to_file = True
+
+    def __init__(self, template_path: Optional[Path] = None):
+        """Initialize the template reporter.
+
+        Args:
+            template_path: Path to the Jinja2 template file.
+        """
+        self._template_path = template_path
+        self._jinja2_available: Optional[bool] = None
+
+    @property
+    def template_path(self) -> Optional[Path]:
+        """Get the template path."""
+        return self._template_path
+
+    @template_path.setter
+    def template_path(self, value: Optional[Path]) -> None:
+        """Set the template path."""
+        self._template_path = value
+
+    def _check_jinja2(self) -> bool:
+        """Check if Jinja2 is available.
+
+        Returns:
+            True if Jinja2 is available, False otherwise.
+        """
+        if self._jinja2_available is None:
+            try:
+                import jinja2  # type: ignore[import-not-found]  # noqa: F401
+
+                self._jinja2_available = True
+            except ImportError:
+                self._jinja2_available = False
+        return self._jinja2_available
+
+    def _get_template_context(self, data: ReportData) -> dict:
+        """Build the template context with allowed variables only.
+
+        This method creates a safe, limited context for template rendering.
+        Only specific variables from ReportData are exposed.
+
+        Args:
+            data: Report data containing all information.
+
+        Returns:
+            Dictionary of template variables.
+        """
+        # Convert features to plain dicts for template use
+        features_list = []
+        for f in data.features:
+            if hasattr(f, "name"):
+                features_list.append({"name": f.name, "dependencies": f.dependencies})
+            else:
+                features_list.append(f)
+
+        return {
+            # Metadata
+            "root_package": data.root_package,
+            "language": data.language,
+            "registry": data.registry,
+            "root_license": data.root_license,
+            "version": data.version,
+            "timestamp": data.timestamp.strftime("%Y-%m-%d %H:%M:%S"),
+            "max_depth": data.max_depth,
+            # Statistics
+            "total_dependencies": data.total_dependencies,
+            "packaged_count": data.packaged_count,
+            "missing_count": data.missing_count,
+            # Optional dependency statistics
+            "include_optional": data.include_optional,
+            "optional_total": data.optional_total,
+            "optional_packaged": data.optional_packaged,
+            "optional_missing": data.optional_missing,
+            # Dev/Build dependency statistics
+            "dev_total": data.dev_total,
+            "dev_packaged": data.dev_packaged,
+            "dev_missing": data.dev_missing,
+            "build_total": data.build_total,
+            "build_packaged": data.build_packaged,
+            "build_missing": data.build_missing,
+            "dev_dependencies": data.dev_dependencies,
+            "build_dependencies": data.build_dependencies,
+            # Features / Extras
+            "features": features_list,
+            # Package lists (sorted for consistent output)
+            "missing_packages": sorted(data.required_missing_packages),
+            "packaged_packages": sorted(data.unique_packaged_packages),
+            "optional_missing_packages": sorted(data.optional_missing_set),
+            # Flags
+            "missing_only": data.missing_only,
+        }
+
+    def generate(self, data: ReportData) -> str:
+        """Generate report content from the template.
+
+        Args:
+            data: Report data containing all information.
+
+        Returns:
+            Rendered template content as a string.
+
+        Raises:
+            RuntimeError: If Jinja2 is not installed or template is not set.
+            FileNotFoundError: If the template file doesn't exist.
+            jinja2.TemplateError: If there's a template syntax error.
+        """
+        if not self._check_jinja2():
+            raise RuntimeError(
+                "Jinja2 is required for template reports. "
+                "Install it with: pip install jinja2"
+            )
+
+        if self._template_path is None:
+            raise RuntimeError(
+                "No template path specified. Use --template to provide a template file."
+            )
+
+        if not self._template_path.exists():
+            raise FileNotFoundError(f"Template file not found: {self._template_path}")
+
+        # Import Jinja2 here (we've already checked it's available)
+        from jinja2 import (  # type: ignore[import-not-found]
+            Environment,
+            FileSystemLoader,
+            StrictUndefined,
+            select_autoescape,
+        )
+
+        # Create Jinja2 environment with security settings
+        env = Environment(
+            loader=FileSystemLoader(self._template_path.parent),
+            autoescape=select_autoescape(default=False),
+            undefined=StrictUndefined,  # Raise error on undefined variables
+            # Disable dangerous features
+            extensions=[],
+        )
+
+        # Add custom filter to strip Rich markup
+        env.filters["strip_markup"] = strip_markup
+
+        # Load and render template
+        template = env.get_template(self._template_path.name)
+        context = self._get_template_context(data)
+
+        return template.render(**context)
+
+    def get_output_filename(self, data: ReportData) -> str:
+        """Get the output filename for the template report.
+
+        Uses the template filename as a base if available, otherwise
+        falls back to the default naming convention.
+
+        Args:
+            data: Report data.
+
+        Returns:
+            Filename string.
+        """
+        timestamp = data.timestamp.strftime("%Y%m%d_%H%M%S")
+        if self._template_path:
+            # Use template name as base (without extension)
+            base_name = self._template_path.stem
+            return f"woolly_{data.root_package}_{base_name}_{timestamp}.md"
+        return f"woolly_{data.root_package}_template_{timestamp}.md"

{woolly-0.3.0.dist-info → woolly-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: woolly
-Version: 0.3.0
+Version: 0.5.0
 Summary: Check if package dependencies are available in Fedora. Supports Rust, Python, and more.
 Author-email: Rodolfo Olivieri <rodolfo.olivieri3@gmail.com>
 License-File: LICENSE
@@ -26,6 +26,8 @@ Requires-Dist: cyclopts>=4.3.0
 Requires-Dist: httpx>=0.28.0
 Requires-Dist: pydantic>=2.10.0
 Requires-Dist: rich>=14.2.0
+Provides-Extra: template
+Requires-Dist: jinja2>=3.1.0; extra == 'template'
 Description-Content-Type: text/markdown
 
 # 🐑 Woolly

woolly-0.5.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+woolly/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+woolly/__main__.py,sha256=em9-CiwyaP3N5FKr_Srv6Eh8Vm6TOC3VWSwXR1BjzV8,304
+woolly/cache.py,sha256=lUoTUd_Ui8052QoOHIc3CcNLQc8ErDwwRK_uP8Qzxjo,2933
+woolly/debug.py,sha256=85_0_lsqccT8TAkyWFinOIqkPVPpcmrKuNfIYQOEqZ4,5294
+woolly/http.py,sha256=bG1AjyF5Umjej-R2ywEPivGarTBiW9Q7bMwy2JsULJU,1521
+woolly/progress.py,sha256=Ij-K3-6-qeVLFKD_WdSfuclZh6uiso9XSSVRlpbB4jA,2040
+woolly/commands/__init__.py,sha256=3xzeIPYD0dmVWwRXHkdPmsF2IIRU6KyvDwgemKdyghI,840
+woolly/commands/check.py,sha256=w3bc8eAdhfrUJeFTGOb7nCsFwBY0B6hQtbOPfInWgRk,20520
+woolly/commands/clear_cache.py,sha256=nCS52v_hNvKTwj62CKrQRfjX53fGpZnWpfB0GMmi8e4,1039
+woolly/commands/list_formats.py,sha256=f4UAWjoBbDu8YhobQyccErwpmOqElrCxBg0xcnJVDUQ,695
+woolly/commands/list_languages.py,sha256=VFjvMgXnvaW3O-MBEpzf5nd89yQ9TqLqcULPDCDUthg,857
+woolly/languages/__init__.py,sha256=CwcPDIMvFpCK1tFbx5rew_5mLrrMy6s4HT6C-ZZz_7M,2527
+woolly/languages/base.py,sha256=OmpMuVSZZo8xjAp6JAZAyr98fH6FQhsPL-BI6YnvOPw,18288
+woolly/languages/python.py,sha256=4EhHKlcDxjyk6_rKaLNmCfLReavJfm1DKyV0SdoJMqY,15303
+woolly/languages/rust.py,sha256=gMCcFRGcNCyEbLruRHk9oxWbW9oYXmVIWXbDVGjnfeg,6674
+woolly/reporters/__init__.py,sha256=-85BHuDAQwyrgWtJqME76FT4jyrvS4cuas7CxaWDODU,3301
+woolly/reporters/base.py,sha256=M8A3vZLPGR7btR10P9Ac56UYDFpH2xC2zCvwL7_xAR8,6911
+woolly/reporters/json.py,sha256=B_QSUs-ldVFhx4ijcRGCLmF0umxQHk2M76E40k-8PUU,9265
+woolly/reporters/markdown.py,sha256=CfYD9t31IgRTU4GfYytWLv-jVTsv5KpZ6J6yEFrv_nE,7454
+woolly/reporters/stdout.py,sha256=1O7jz2u_6Onr5dLnWqcHamxID-fHBaIAfqnE5ZEC0i0,8126
+woolly/reporters/template.py,sha256=C9amNJ3kJg6Cv8DCcLM3QiOIV_Sa8I1qAWIoAODv0D8,9066
+woolly-0.5.0.dist-info/METADATA,sha256=BZ0GnVZv7N1lyQrTZB35jwMtEmK0yotyoKpEepE4qbA,10477
+woolly-0.5.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+woolly-0.5.0.dist-info/entry_points.txt,sha256=tMSCR0PXsaIWiiY5fwQ5eowwNqPSrH0j9QriPDoE75k,48
+woolly-0.5.0.dist-info/licenses/LICENSE,sha256=TnfrdmTYydTTenujKk2LdAuDuLSMwjpXhW7EU2VR0e8,1064
+woolly-0.5.0.dist-info/RECORD,,

woolly-0.3.0.dist-info/RECORD

@@ -1,25 +0,0 @@
-woolly/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-woolly/__main__.py,sha256=em9-CiwyaP3N5FKr_Srv6Eh8Vm6TOC3VWSwXR1BjzV8,304
-woolly/cache.py,sha256=tzZE0FrymWQZSpJ5ZFgv2G17CVYq7SzsxpVWsF7ByXI,2405
-woolly/debug.py,sha256=85_0_lsqccT8TAkyWFinOIqkPVPpcmrKuNfIYQOEqZ4,5294
-woolly/http.py,sha256=xPFbHPWEWTN4mjEONyJ9hERmb62mMWun0jRjTAaaNE8,872
-woolly/progress.py,sha256=Ij-K3-6-qeVLFKD_WdSfuclZh6uiso9XSSVRlpbB4jA,2040
-woolly/commands/__init__.py,sha256=3xzeIPYD0dmVWwRXHkdPmsF2IIRU6KyvDwgemKdyghI,840
-woolly/commands/check.py,sha256=kCFQClTOiBAP-DRpAQFbDGgIKiPv8SlMYKoQzx6Fq4E,13312
-woolly/commands/clear_cache.py,sha256=nCS52v_hNvKTwj62CKrQRfjX53fGpZnWpfB0GMmi8e4,1039
-woolly/commands/list_formats.py,sha256=f4UAWjoBbDu8YhobQyccErwpmOqElrCxBg0xcnJVDUQ,695
-woolly/commands/list_languages.py,sha256=VFjvMgXnvaW3O-MBEpzf5nd89yQ9TqLqcULPDCDUthg,857
-woolly/languages/__init__.py,sha256=CwcPDIMvFpCK1tFbx5rew_5mLrrMy6s4HT6C-ZZz_7M,2527
-woolly/languages/base.py,sha256=Sjm9wXWeM36w6eYx_YyHm0jM6TqAUshlCiSPczW1_IA,12365
-woolly/languages/python.py,sha256=aA1fmHO0VWV_sHjZF92G30frv916Veh6cqjIj354UgM,6723
-woolly/languages/rust.py,sha256=DdhflO0PDvpgGy41lst9vUW9vF1Xrf94RJIMAsWSRDc,4508
-woolly/reporters/__init__.py,sha256=dS1XZGPTjvCkDetiWikkmBn7OnpvnmMXGZDYz2LVQr4,2833
-woolly/reporters/base.py,sha256=xXwrNb2NVVktQHjYCBT4nCzdqpvQsVCVsSs5-hB0D8I,6264
-woolly/reporters/json.py,sha256=mJb3tZDxvzEZ2zeOKELKJaU1E3b4TG86_DtsEJ8JHGE,5707
-woolly/reporters/markdown.py,sha256=fh--BH1rQP46qhTXiWcTHX3X9kjQJsAAXFFiToqK-RA,4300
-woolly/reporters/stdout.py,sha256=Xzku45BElUFyHh_pCWqAW4efb2mhC54CEja0xN6Xoe0,2784
-woolly-0.3.0.dist-info/METADATA,sha256=SMLGfdfa3_Rk6S36nGkJfiagX2bvmYMpb4llzvE6NCc,10402
-woolly-0.3.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-woolly-0.3.0.dist-info/entry_points.txt,sha256=tMSCR0PXsaIWiiY5fwQ5eowwNqPSrH0j9QriPDoE75k,48
-woolly-0.3.0.dist-info/licenses/LICENSE,sha256=TnfrdmTYydTTenujKk2LdAuDuLSMwjpXhW7EU2VR0e8,1064
-woolly-0.3.0.dist-info/RECORD,,