greenmining 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

greenmining/__init__.py

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

{greenmining-1.0.2.dist-info → greenmining-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: greenmining
-Version: 1.0.2
+Version: 1.0.3
 Summary: Analyze GitHub repositories to identify green software engineering patterns and energy-efficient practices
 Author-email: Adam Bouafia <a.bouafia@student.vu.nl>
 License: MIT
@@ -397,6 +397,119 @@ controller.generate_report()
 print("Analysis complete! Check data/ directory for results.")
 ```
 
+#### Complete Working Example: Full Pipeline
+
+This is a complete, production-ready example that demonstrates the entire analysis pipeline. This example successfully analyzed 100 repositories with 30,543 commits in our testing.
+
+```python
+import os
+from pathlib import Path
+from dotenv import load_dotenv
+
+# Load environment variables
+load_dotenv()
+
+# Import from greenmining package
+from greenmining import fetch_repositories
+from greenmining.services.commit_extractor import CommitExtractor
+from greenmining.services.data_analyzer import DataAnalyzer
+from greenmining.services.data_aggregator import DataAggregator
+
+# Configuration
+token = os.getenv("GITHUB_TOKEN")
+output_dir = Path("results")
+output_dir.mkdir(exist_ok=True)
+
+# STAGE 1: Fetch Repositories
+print("Fetching repositories...")
+repositories = fetch_repositories(
+    github_token=token,
+    max_repos=100,
+    min_stars=10,
+    keywords="software engineering",
+)
+print(f"✓ Fetched {len(repositories)} repositories")
+
+# STAGE 2: Extract Commits
+print("\nExtracting commits...")
+extractor = CommitExtractor(
+    github_token=token,
+    max_commits=1000,
+    skip_merges=True,
+    days_back=730,
+    timeout=120,
+)
+all_commits = extractor.extract_from_repositories(repositories)
+print(f"✓ Extracted {len(all_commits)} commits")
+
+# Save commits
+extractor.save_results(
+    all_commits,
+    output_dir / "commits.json",
+    len(repositories)
+)
+
+# STAGE 3: Analyze Commits
+print("\nAnalyzing commits...")
+analyzer = DataAnalyzer(
+    enable_nlp=True,
+    enable_ml_features=True,
+    enable_diff_analysis=False,  # Set to True for detailed code analysis (slower)
+)
+analyzed_commits = analyzer.analyze_commits(all_commits)
+
+# Count green-aware commits
+green_count = sum(1 for c in analyzed_commits if c.get("green_aware", False))
+green_percentage = (green_count / len(analyzed_commits) * 100) if analyzed_commits else 0
+print(f"✓ Analyzed {len(analyzed_commits)} commits")
+print(f"✓ Green-aware: {green_count} ({green_percentage:.1f}%)")
+
+# Save analysis
+analyzer.save_results(analyzed_commits, output_dir / "analyzed.json")
+
+# STAGE 4: Aggregate Results
+print("\nAggregating results...")
+aggregator = DataAggregator(
+    enable_enhanced_stats=True,
+    enable_temporal=True,
+    temporal_granularity="quarter",
+)
+results = aggregator.aggregate(analyzed_commits, repositories)
+
+# STAGE 5: Save Results
+print("\nSaving results...")
+aggregator.save_results(
+    results,
+    output_dir / "aggregated.json",
+    output_dir / "aggregated.csv",
+    analyzed_commits
+)
+
+# Print summary
+print("\n" + "="*80)
+print("ANALYSIS COMPLETE")
+print("="*80)
+aggregator.print_summary(results)
+print(f"\n📁 Results saved in: {output_dir.absolute()}")
+```
+
+**What this example does:**
+
+1. **Fetches repositories** from GitHub based on keywords and filters
+2. **Extracts commits** from each repository (up to 1000 per repo)
+3. **Analyzes commits** for green software patterns using NLP and ML
+4. **Aggregates results** with temporal analysis and enhanced statistics
+5. **Saves results** to JSON and CSV files for further analysis
+
+**Expected output files:**
+- `commits.json` - All extracted commits with metadata
+- `analyzed.json` - Commits analyzed for green patterns
+- `aggregated.json` - Summary statistics and pattern distributions
+- `aggregated.csv` - Tabular format for spreadsheet analysis
+- `metadata.json` - Experiment configuration and timing
+
+**Performance:** This pipeline successfully processed 100 repositories (30,543 commits) in approximately 6.4 hours, identifying 7,600 green-aware commits (24.9%).
+
 ### Docker Usage
 
 ```bash

{greenmining-1.0.2.dist-info → greenmining-1.0.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-greenmining/__init__.py,sha256=c_Vaq_WW6-SkI_es4cQKXpdEtXdfVEnGjIDxACF6bzk,1764
+greenmining/__init__.py,sha256=p_pk0TmyP34o97wTYVTHkXe7qpGtH43GUVD_iCadrYY,1763
 greenmining/__main__.py,sha256=1RwcSXcwdza6xJX5fRT8-HhZjlnKbkmGY_uxTm-NYZ4,138
 greenmining/__version__.py,sha256=3OgUZ5K2OXa9_-2kjlgye1N6G_QeQDeex2uw33Ja6Cs,66
 greenmining/cli.py,sha256=40eKDEZHNeDVb91xKBG70VfPk45mwb4YjuVCC2efVPA,17458
@@ -28,9 +28,9 @@ greenmining/services/data_aggregator.py,sha256=OqJvQZp9xaZaSmbwWoiHAHECAghd8agbh
 greenmining/services/data_analyzer.py,sha256=HZDQLFZDCwCUGIzRjypyXC09Fl_-zaxhly74n3siwQc,16325
 greenmining/services/github_fetcher.py,sha256=J47-plM_NKXwHDSWNBuSUZMnZnGP6wXiJyrVfeWT9ug,11360
 greenmining/services/reports.py,sha256=NCNI9SCTnSLeAO8WmkNIdkB0hr-XyVpuzV0sovOoUOM,27107
-greenmining-1.0.2.dist-info/licenses/LICENSE,sha256=M7ma3JHGeiIZIs3ea0HTcFl_wLFPX2NZElUliYs4bCA,1083
-greenmining-1.0.2.dist-info/METADATA,sha256=vTygz3S30HRdkpHdMIiD-jau6Lx60VcPsf3OSSBeL0w,25694
-greenmining-1.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-greenmining-1.0.2.dist-info/entry_points.txt,sha256=oHvTWMzNFGf2W3CFEKVVPsG4exeMv0MaQu9YsUoQ9lw,53
-greenmining-1.0.2.dist-info/top_level.txt,sha256=nreXgXxZIWI-42yQknQ0HXtUrFnzZ8N1ra4Mdy2KcsI,12
-greenmining-1.0.2.dist-info/RECORD,,
+greenmining-1.0.3.dist-info/licenses/LICENSE,sha256=M7ma3JHGeiIZIs3ea0HTcFl_wLFPX2NZElUliYs4bCA,1083
+greenmining-1.0.3.dist-info/METADATA,sha256=0Hj5qXVUkuJhIUBZBRhSysc3zx6L3py0HpZg9vKcl7Y,29260
+greenmining-1.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+greenmining-1.0.3.dist-info/entry_points.txt,sha256=oHvTWMzNFGf2W3CFEKVVPsG4exeMv0MaQu9YsUoQ9lw,53
+greenmining-1.0.3.dist-info/top_level.txt,sha256=nreXgXxZIWI-42yQknQ0HXtUrFnzZ8N1ra4Mdy2KcsI,12
+greenmining-1.0.3.dist-info/RECORD,,