greenmining 1.1.6__tar.gz → 1.1.7__tar.gz

{greenmining-1.1.6 → greenmining-1.1.7}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [1.1.7] - 2026-01-31
+
+### Removed
+- Web dashboard module (`greenmining/dashboard/`) and Flask dependency
+- Dashboard documentation page and all dashboard references
+
+### Fixed
+- ReadTheDocs experiment page not rendering (trailing whitespace in mkdocs nav)
+- Plotly rendering in notebook (nbformat dependency)
+
 ## [1.1.6] - 2026-01-31
 
 ### Fixed
@@ -11,7 +21,7 @@
 ### Added
 - `since_date` / `to_date` parameters for date-bounded commit analysis
 - `created_before` / `pushed_after` search filters
-- Dashboard, GraphQL API, and experiment documentation pages
+- GraphQL API and experiment documentation pages
 - Full process metrics and method-level metrics documentation
 
 ### Changed

{greenmining-1.1.6/greenmining.egg-info → greenmining-1.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: greenmining
-Version: 1.1.6
+Version: 1.1.7
 Summary: An empirical Python library for Mining Software Repositories (MSR) in Green IT research
 Author-email: Adam Bouafia <a.bouafia@student.vu.nl>
 License: MIT
@@ -49,8 +49,6 @@ Requires-Dist: twine; extra == "dev"
 Provides-Extra: energy
 Requires-Dist: psutil; extra == "energy"
 Requires-Dist: codecarbon; extra == "energy"
-Provides-Extra: dashboard
-Requires-Dist: flask; extra == "dashboard"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-rtd-theme; extra == "docs"
@@ -80,7 +78,6 @@ An empirical Python library for Mining Software Repositories (MSR) in Green IT r
 - **Method-level analysis** - Per-method complexity and metrics via Lizard integration
 - **Version power comparison** - Compare power consumption across software versions
 - **Generate research datasets** - Statistical analysis, temporal trends, and publication-ready reports
-- **Web dashboard** - Flask-based interactive visualization of analysis results
 
 Whether you're conducting MSR research, analyzing green software adoption, or measuring the energy footprint of codebases, GreenMining provides the empirical toolkit you need.
 
@@ -452,15 +449,6 @@ print(f"Spearman: {correlator.spearman}")
 print(f"Feature importance: {correlator.feature_importance}")
 ```
 
-#### Web Dashboard
-
-```python
-from greenmining.dashboard import run_dashboard
-
-# Launch interactive dashboard (requires pip install greenmining[dashboard])
-run_dashboard(data_dir="./data", host="127.0.0.1", port=5000)
-```
-
 #### Pipeline Batch Analysis
 
 ```python
@@ -698,7 +686,6 @@ config = Config(
 - **Full Process Metrics**: All 8 process metrics (ChangeSet, CodeChurn, CommitsCount, ContributorsCount, ContributorsExperience, HistoryComplexity, HunksCount, LinesCount)
 - **Statistical Analysis**: Correlations, effect sizes, and temporal trends
 - **Multi-format Output**: Markdown reports, CSV exports, JSON data
-- **Web Dashboard**: Flask-based interactive visualization (`pip install greenmining[dashboard]`)
 - **Docker Support**: Pre-built images for containerized analysis
 
 ### Energy Measurement
@@ -857,7 +844,6 @@ ruff check greenmining/ tests/
 
 ```bash
 pip install greenmining[energy]      # psutil, codecarbon (energy measurement)
-pip install greenmining[dashboard]   # flask (web dashboard)
 pip install greenmining[dev]         # pytest, black, ruff, mypy (development)
 ```
 

{greenmining-1.1.6 → greenmining-1.1.7}/README.md

@@ -21,7 +21,6 @@ An empirical Python library for Mining Software Repositories (MSR) in Green IT r
 - **Method-level analysis** - Per-method complexity and metrics via Lizard integration
 - **Version power comparison** - Compare power consumption across software versions
 - **Generate research datasets** - Statistical analysis, temporal trends, and publication-ready reports
-- **Web dashboard** - Flask-based interactive visualization of analysis results
 
 Whether you're conducting MSR research, analyzing green software adoption, or measuring the energy footprint of codebases, GreenMining provides the empirical toolkit you need.
 
@@ -393,15 +392,6 @@ print(f"Spearman: {correlator.spearman}")
 print(f"Feature importance: {correlator.feature_importance}")
 ```
 
-#### Web Dashboard
-
-```python
-from greenmining.dashboard import run_dashboard
-
-# Launch interactive dashboard (requires pip install greenmining[dashboard])
-run_dashboard(data_dir="./data", host="127.0.0.1", port=5000)
-```
-
 #### Pipeline Batch Analysis
 
 ```python
@@ -639,7 +629,6 @@ config = Config(
 - **Full Process Metrics**: All 8 process metrics (ChangeSet, CodeChurn, CommitsCount, ContributorsCount, ContributorsExperience, HistoryComplexity, HunksCount, LinesCount)
 - **Statistical Analysis**: Correlations, effect sizes, and temporal trends
 - **Multi-format Output**: Markdown reports, CSV exports, JSON data
-- **Web Dashboard**: Flask-based interactive visualization (`pip install greenmining[dashboard]`)
 - **Docker Support**: Pre-built images for containerized analysis
 
 ### Energy Measurement
@@ -798,7 +787,6 @@ ruff check greenmining/ tests/
 
 ```bash
 pip install greenmining[energy]      # psutil, codecarbon (energy measurement)
-pip install greenmining[dashboard]   # flask (web dashboard)
 pip install greenmining[dev]         # pytest, black, ruff, mypy (development)
 ```
 

{greenmining-1.1.6 → greenmining-1.1.7}/greenmining/__init__.py

@@ -9,7 +9,7 @@ from greenmining.gsf_patterns import (
     is_green_aware,
 )
 
-__version__ = "1.1.6"
+__version__ = "1.1.7"
 
 
 def fetch_repositories(

{greenmining-1.1.6 → greenmining-1.1.7/greenmining.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: greenmining
-Version: 1.1.6
+Version: 1.1.7
 Summary: An empirical Python library for Mining Software Repositories (MSR) in Green IT research
 Author-email: Adam Bouafia <a.bouafia@student.vu.nl>
 License: MIT
@@ -49,8 +49,6 @@ Requires-Dist: twine; extra == "dev"
 Provides-Extra: energy
 Requires-Dist: psutil; extra == "energy"
 Requires-Dist: codecarbon; extra == "energy"
-Provides-Extra: dashboard
-Requires-Dist: flask; extra == "dashboard"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-rtd-theme; extra == "docs"
@@ -80,7 +78,6 @@ An empirical Python library for Mining Software Repositories (MSR) in Green IT r
 - **Method-level analysis** - Per-method complexity and metrics via Lizard integration
 - **Version power comparison** - Compare power consumption across software versions
 - **Generate research datasets** - Statistical analysis, temporal trends, and publication-ready reports
-- **Web dashboard** - Flask-based interactive visualization of analysis results
 
 Whether you're conducting MSR research, analyzing green software adoption, or measuring the energy footprint of codebases, GreenMining provides the empirical toolkit you need.
 
@@ -452,15 +449,6 @@ print(f"Spearman: {correlator.spearman}")
 print(f"Feature importance: {correlator.feature_importance}")
 ```
 
-#### Web Dashboard
-
-```python
-from greenmining.dashboard import run_dashboard
-
-# Launch interactive dashboard (requires pip install greenmining[dashboard])
-run_dashboard(data_dir="./data", host="127.0.0.1", port=5000)
-```
-
 #### Pipeline Batch Analysis
 
 ```python
@@ -698,7 +686,6 @@ config = Config(
 - **Full Process Metrics**: All 8 process metrics (ChangeSet, CodeChurn, CommitsCount, ContributorsCount, ContributorsExperience, HistoryComplexity, HunksCount, LinesCount)
 - **Statistical Analysis**: Correlations, effect sizes, and temporal trends
 - **Multi-format Output**: Markdown reports, CSV exports, JSON data
-- **Web Dashboard**: Flask-based interactive visualization (`pip install greenmining[dashboard]`)
 - **Docker Support**: Pre-built images for containerized analysis
 
 ### Energy Measurement
@@ -857,7 +844,6 @@ ruff check greenmining/ tests/
 
 ```bash
 pip install greenmining[energy]      # psutil, codecarbon (energy measurement)
-pip install greenmining[dashboard]   # flask (web dashboard)
 pip install greenmining[dev]         # pytest, black, ruff, mypy (development)
 ```
 

{greenmining-1.1.6 → greenmining-1.1.7}/greenmining.egg-info/SOURCES.txt

@@ -20,8 +20,6 @@ setup.py
 ./greenmining/analyzers/version_power_analyzer.py
 ./greenmining/controllers/__init__.py
 ./greenmining/controllers/repository_controller.py
-./greenmining/dashboard/__init__.py
-./greenmining/dashboard/app.py
 ./greenmining/energy/__init__.py
 ./greenmining/energy/base.py
 ./greenmining/energy/carbon_reporter.py
@@ -64,8 +62,6 @@ greenmining/analyzers/temporal_analyzer.py
 greenmining/analyzers/version_power_analyzer.py
 greenmining/controllers/__init__.py
 greenmining/controllers/repository_controller.py
-greenmining/dashboard/__init__.py
-greenmining/dashboard/app.py
 greenmining/energy/__init__.py
 greenmining/energy/base.py
 greenmining/energy/carbon_reporter.py

{greenmining-1.1.6 → greenmining-1.1.7}/greenmining.egg-info/requires.txt

@@ -9,9 +9,6 @@ plotly
 python-dotenv
 requests
 
-[dashboard]
-flask
-
 [dev]
 pytest
 pytest-cov

{greenmining-1.1.6 → greenmining-1.1.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "greenmining"
-version = "1.1.6"
+version = "1.1.7"
 description = "An empirical Python library for Mining Software Repositories (MSR) in Green IT research"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -72,9 +72,6 @@ energy = [
     "codecarbon"
 ]
 
-dashboard = [
-    "flask"
-]
 
 docs = [
     "sphinx",

greenmining-1.1.6/greenmining/dashboard/__init__.py

@@ -1,5 +0,0 @@
-# Web dashboard module for GreenMining visualization.
-
-from .app import create_app, run_dashboard
-
-__all__ = ["create_app", "run_dashboard"]

greenmining-1.1.6/greenmining/dashboard/app.py

@@ -1,200 +0,0 @@
-# Flask-based web dashboard for GreenMining analysis visualization.
-# Provides interactive charts for repository analysis, pattern distribution,
-# temporal trends, and energy consumption.
-
-from __future__ import annotations
-
-import json
-from pathlib import Path
-from typing import Any, Dict, List, Optional
-
-
-def create_app(data_dir: str = "./data"):
-    # Create Flask application for the dashboard.
-    # Args:
-    #   data_dir: Path to directory containing analysis JSON files
-    # Returns:
-    #   Flask application instance
-    try:
-        from flask import Flask, render_template_string, jsonify, request
-    except ImportError:
-        raise ImportError("Flask is required for the dashboard. Install it with: pip install flask")
-
-    app = Flask(__name__)
-    data_path = Path(data_dir)
-
-    def _load_data(filename: str) -> Dict[str, Any]:
-        filepath = data_path / filename
-        if filepath.exists():
-            with open(filepath, encoding="utf-8") as f:
-                return json.load(f)
-        return {}
-
-    @app.route("/")
-    def index():
-        return render_template_string(DASHBOARD_HTML)
-
-    @app.route("/api/repositories")
-    def api_repositories():
-        data = _load_data("repositories.json")
-        return jsonify(data)
-
-    @app.route("/api/analysis")
-    def api_analysis():
-        data = _load_data("analysis_results.json")
-        return jsonify(data)
-
-    @app.route("/api/statistics")
-    def api_statistics():
-        data = _load_data("aggregated_statistics.json")
-        return jsonify(data)
-
-    @app.route("/api/energy")
-    def api_energy():
-        data = _load_data("energy_report.json")
-        return jsonify(data)
-
-    @app.route("/api/summary")
-    def api_summary():
-        # Build summary from available data
-        repos = _load_data("repositories.json")
-        analysis = _load_data("analysis_results.json")
-
-        repo_count = 0
-        if isinstance(repos, list):
-            repo_count = len(repos)
-        elif isinstance(repos, dict):
-            repo_count = repos.get("total_repositories", len(repos.get("repositories", [])))
-
-        commit_count = 0
-        green_count = 0
-        if isinstance(analysis, list):
-            commit_count = len(analysis)
-            green_count = sum(1 for a in analysis if a.get("green_aware"))
-        elif isinstance(analysis, dict):
-            results = analysis.get("results", [])
-            for r in results:
-                commits = r.get("commits", [])
-                commit_count += len(commits)
-                green_count += sum(1 for c in commits if c.get("green_aware"))
-
-        green_rate = (green_count / commit_count * 100) if commit_count > 0 else 0
-
-        return jsonify(
-            {
-                "repositories": repo_count,
-                "commits_analyzed": commit_count,
-                "green_commits": green_count,
-                "green_rate": round(green_rate, 1),
-            }
-        )
-
-    return app
-
-
-def run_dashboard(data_dir: str = "./data", host: str = "127.0.0.1", port: int = 5000):
-    # Run the dashboard server.
-    # Args:
-    #   data_dir: Path to analysis data directory
-    #   host: Host to bind to
-    #   port: Port to bind to
-    app = create_app(data_dir)
-    print(f"GreenMining Dashboard running at http://{host}:{port}")
-    print(f"Data directory: {data_dir}")
-    app.run(host=host, port=port, debug=False)
-
-
-# Dashboard HTML template with embedded JS (no external dependencies)
-DASHBOARD_HTML = """
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>GreenMining Dashboard</title>
-    <style>
-        * { margin: 0; padding: 0; box-sizing: border-box; }
-        body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
-               background: #f5f7fa; color: #333; }
-        .header { background: #1a472a; color: white; padding: 20px 40px; }
-        .header h1 { font-size: 24px; font-weight: 600; }
-        .header p { font-size: 14px; opacity: 0.8; margin-top: 4px; }
-        .container { max-width: 1200px; margin: 0 auto; padding: 20px; }
-        .grid { display: grid; grid-template-columns: repeat(4, 1fr); gap: 16px; margin-bottom: 24px; }
-        .card { background: white; border-radius: 8px; padding: 20px; box-shadow: 0 1px 3px rgba(0,0,0,0.1); }
-        .card h3 { font-size: 13px; color: #666; text-transform: uppercase; letter-spacing: 0.5px; }
-        .card .value { font-size: 32px; font-weight: 700; color: #1a472a; margin-top: 8px; }
-        .card .subtitle { font-size: 12px; color: #999; margin-top: 4px; }
-        .section { margin-bottom: 24px; }
-        .section h2 { font-size: 18px; margin-bottom: 12px; color: #1a472a; }
-        table { width: 100%; border-collapse: collapse; background: white; border-radius: 8px;
-                overflow: hidden; box-shadow: 0 1px 3px rgba(0,0,0,0.1); }
-        th, td { padding: 12px 16px; text-align: left; border-bottom: 1px solid #eee; }
-        th { background: #f8f9fa; font-size: 12px; text-transform: uppercase; color: #666; }
-        td { font-size: 14px; }
-        .badge { display: inline-block; padding: 2px 8px; border-radius: 12px; font-size: 11px; }
-        .badge-green { background: #d4edda; color: #155724; }
-        .badge-gray { background: #e9ecef; color: #495057; }
-        .bar { height: 8px; background: #e9ecef; border-radius: 4px; overflow: hidden; }
-        .bar-fill { height: 100%; background: #1a472a; border-radius: 4px;
-                     transition: width 0.5s ease; }
-        .loading { text-align: center; padding: 40px; color: #999; }
-    </style>
-</head>
-<body>
-    <div class="header">
-        <h1>GreenMining Dashboard</h1>
-        <p>Mining Software Repositories for Green IT Research</p>
-    </div>
-    <div class="container">
-        <div class="grid" id="summary-cards">
-            <div class="card"><h3>Repositories</h3><div class="value" id="repo-count">-</div></div>
-            <div class="card"><h3>Commits Analyzed</h3><div class="value" id="commit-count">-</div></div>
-            <div class="card"><h3>Green Commits</h3><div class="value" id="green-count">-</div></div>
-            <div class="card"><h3>Green Rate</h3><div class="value" id="green-rate">-</div></div>
-        </div>
-        <div class="section">
-            <h2>Repositories</h2>
-            <div id="repo-table"><div class="loading">Loading data...</div></div>
-        </div>
-    </div>
-    <script>
-        async function loadDashboard() {
-            try {
-                const summary = await fetch('/api/summary').then(r => r.json());
-                document.getElementById('repo-count').textContent = summary.repositories;
-                document.getElementById('commit-count').textContent = summary.commits_analyzed.toLocaleString();
-                document.getElementById('green-count').textContent = summary.green_commits.toLocaleString();
-                document.getElementById('green-rate').textContent = summary.green_rate + '%';
-            } catch(e) {
-                console.log('Summary not available:', e);
-            }
-
-            try {
-                const repos = await fetch('/api/repositories').then(r => r.json());
-                const list = repos.repositories || (Array.isArray(repos) ? repos : []);
-                if (list.length > 0) {
-                    let html = '<table><thead><tr><th>Repository</th><th>Language</th>' +
-                        '<th>Stars</th><th>Description</th></tr></thead><tbody>';
-                    list.slice(0, 50).forEach(r => {
-                        html += '<tr><td><strong>' + (r.full_name || r.name) + '</strong></td>' +
-                            '<td><span class="badge badge-green">' + (r.language || '-') + '</span></td>' +
-                            '<td>' + (r.stars || 0).toLocaleString() + '</td>' +
-                            '<td>' + (r.description || '-').substring(0, 80) + '</td></tr>';
-                    });
-                    html += '</tbody></table>';
-                    document.getElementById('repo-table').innerHTML = html;
-                } else {
-                    document.getElementById('repo-table').innerHTML =
-                        '<div class="card">No repository data found. Run an analysis first.</div>';
-                }
-            } catch(e) {
-                document.getElementById('repo-table').innerHTML =
-                    '<div class="card">Run an analysis to populate the dashboard.</div>';
-            }
-        }
-        loadDashboard();
-    </script>
-</body>
-</html>
-"""