greenmining 1.1.8__tar.gz → 1.2.0__tar.gz

greenmining-1.2.0/CHANGELOG.md

@@ -0,0 +1,96 @@
+# Changelog
+
+## [1.2.0] - 2026-01-31
+
+### Added
+- `clone_repositories()` top-level function for cloning repos into `./greenmining_repos/` with sanitized directory names
+- Repository name sanitization (`_sanitize_repo_name`) to prevent filesystem issues from special characters
+- 2 missing official GSF patterns: "Match Utilization Requirements with Pre-configured Servers", "Optimize Impact on Customer Devices and Equipment"
+- 11 new green keywords (energy proportionality, backward compatible, customer device, device lifetime, etc.)
+- GSF pattern database now covers 100% of the official Green Software Foundation catalog (61/61)
+
+### Changed
+- Repositories now clone to `./greenmining_repos/` instead of `/tmp` (fixes OS cleanup and permission issues)
+- `fetch_repositories()` takes direct parameters -- no Config intermediary
+- All function defaults are explicit parameters instead of config file values
+- Default supported languages updated from 7 to 20 (matches experiment scope)
+- Library reference documentation added to mkdocs navigation
+
+### Removed
+- **`config.py`** module entirely (Config class, get_config singleton, .env/YAML loading layer)
+- **`__version__.py`** (stale orphaned file with wrong version 1.0.5)
+- **`services/github_fetcher.py`** (empty deprecated REST API stub)
+- **`analyzers/power_regression.py`** (PowerRegressionDetector -- requires running repo code, not feasible in current pipeline)
+- **`analyzers/version_power_analyzer.py`** (VersionPowerAnalyzer -- same reason)
+- **`analyzers/qualitative_analyzer.py`** (QualitativeAnalyzer -- unused)
+- **`presenters/`** module (ConsolePresenter -- never used by any code)
+- **`docs/reference/config-options.md`** (obsolete config reference page)
+- 10 dead utility functions (estimate_tokens, estimate_cost, print_banner, print_section, load_csv_file, handle_github_rate_limit, format_duration, truncate_text, create_checkpoint, load_checkpoint)
+- 35+ unused Config attributes that were set but never read
+- Dead imports across 14 files
+- Dead methods: DataAnalyzer._check_green_awareness, DataAnalyzer._detect_known_pattern, CommitExtractor._extract_commit_metadata, StatisticalAnalyzer.pattern_adoption_rate_analysis, CodeCarbonMeter.get_carbon_intensity, Config.validate
+
+## [1.1.9] - 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
+- EnergyMetrics property aliases (`energy_joules`, `average_power_watts`)
+- Parallel energy measurement conflict with shared meter instance
+- StatisticalAnalyzer timezone-aware date handling
+- DataFrame column collision in pattern correlation analysis
+
+### Added
+- `since_date` / `to_date` parameters for date-bounded commit analysis
+- `created_before` / `pushed_after` search filters
+- GraphQL API and experiment documentation pages
+- Full process metrics and method-level metrics documentation
+
+### Changed
+- Energy measurement demonstrates all 4 backends: RAPL, CPU Meter, CodeCarbon, tracemalloc
+- Removed all PyDriller references (replaced with gitpython + lizard)
+
+### Removed
+- Qualitative Validation and Carbon Footprint Reporting steps from experiment
+
+## [0.1.12] - 2025-12-03
+
+### Added
+- Custom search keywords for repository fetching (`--keywords` option)
+- `fetch_repositories()` function exposed in public API
+
+### Changed
+- README updated to reflect 122 patterns (was showing 76 in PyPI description)
+
+## [0.1.11] - 2025-12-03
+
+### Added
+- Expanded pattern database from 76 to 122 patterns
+- Added 9 new categories
+- Expanded keywords from 190 to 321
+- VU Amsterdam 2024 research patterns for ML systems
+
+## [0.1.0] - 2025-12-02
+
+### Added
+- Initial release
+- Core functionality for GSF pattern mining
+- Support for 100 microservices repositories
+- Pattern matching with 76 GSF patterns
+- Green awareness analysis
+- Docker containerization
+
+[1.2.0]: https://github.com/adam-bouafia/greenmining/compare/v1.1.9...v1.2.0
+[1.1.9]: https://github.com/adam-bouafia/greenmining/compare/v1.1.6...v1.1.9
+[1.1.6]: https://github.com/adam-bouafia/greenmining/compare/v0.1.12...v1.1.6
+[0.1.12]: https://github.com/adam-bouafia/greenmining/compare/v0.1.11...v0.1.12
+[0.1.11]: https://github.com/adam-bouafia/greenmining/compare/v0.1.0...v0.1.11
+[0.1.0]: https://github.com/adam-bouafia/greenmining/releases/tag/v0.1.0

greenmining-1.2.0/PKG-INFO

@@ -0,0 +1,311 @@
+Metadata-Version: 2.4
+Name: greenmining
+Version: 1.2.0
+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
+Project-URL: Homepage, https://github.com/adam-bouafia/greenmining
+Project-URL: Documentation, https://github.com/adam-bouafia/greenmining#readme
+Project-URL: Linkedin, https://www.linkedin.com/in/adam-bouafia/
+Project-URL: Repository, https://github.com/adam-bouafia/greenmining
+Project-URL: Issues, https://github.com/adam-bouafia/greenmining/issues
+Project-URL: Changelog, https://github.com/adam-bouafia/greenmining/blob/main/CHANGELOG.md
+Keywords: green-software,gsf,msr,mining-software-repositories,green-it,sustainability,carbon-footprint,energy-efficiency,repository-analysis,github-analysis,pydriller,empirical-software-engineering
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyGithub
+Requires-Dist: PyDriller
+Requires-Dist: pandas
+Requires-Dist: colorama
+Requires-Dist: tabulate
+Requires-Dist: tqdm
+Requires-Dist: matplotlib
+Requires-Dist: plotly
+Requires-Dist: python-dotenv
+Requires-Dist: requests
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: energy
+Requires-Dist: psutil; extra == "energy"
+Requires-Dist: codecarbon; extra == "energy"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Dynamic: license-file
+
+# greenmining
+
+An empirical Python library for Mining Software Repositories (MSR) in Green IT research.
+
+[![PyPI](https://img.shields.io/pypi/v/greenmining)](https://pypi.org/project/greenmining/)
+[![Python](https://img.shields.io/pypi/pyversions/greenmining)](https://pypi.org/project/greenmining/)
+[![License](https://img.shields.io/github/license/adam-bouafia/greenmining)](LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-readthedocs-blue)](https://greenmining.readthedocs.io/)
+
+## Overview
+
+`greenmining` is a research-grade Python library designed for **empirical Mining Software Repositories (MSR)** studies in **Green IT**. It enables researchers and practitioners to:
+
+- **Mine repositories at scale** - Search, fetch, and clone GitHub repositories via GraphQL API with configurable filters
+- **Classify green commits** - Detect 124 sustainability patterns from the Green Software Foundation (GSF) catalog using 332 keywords
+- **Analyze any repository by URL** - Direct Git-based analysis with support for private repositories
+- **Measure energy consumption** - RAPL, CodeCarbon, and CPU Energy Meter backends for power profiling
+- **Carbon footprint reporting** - CO2 emissions calculation with 20+ country profiles and cloud region support
+- **Method-level analysis** - Per-method complexity and metrics via Lizard integration
+- **Generate research datasets** - Statistical analysis, temporal trends, and publication-ready reports
+
+## Installation
+
+### Via pip
+
+```bash
+pip install greenmining
+```
+
+### With energy measurement
+
+```bash
+pip install greenmining[energy]
+```
+
+### From source
+
+```bash
+git clone https://github.com/adam-bouafia/greenmining.git
+cd greenmining
+pip install -e .
+```
+
+## Quick Start
+
+### Pattern Detection
+
+```python
+from greenmining import GSF_PATTERNS, is_green_aware, get_pattern_by_keywords
+
+print(f"Total patterns: {len(GSF_PATTERNS)}")  # 124 patterns across 15 categories
+
+commit_msg = "Optimize Redis caching to reduce energy consumption"
+if is_green_aware(commit_msg):
+    patterns = get_pattern_by_keywords(commit_msg)
+    print(f"Matched patterns: {patterns}")
+```
+
+### Fetch Repositories
+
+```python
+from greenmining import fetch_repositories
+
+repos = fetch_repositories(
+    github_token="your_token",
+    max_repos=50,
+    min_stars=500,
+    keywords="kubernetes cloud-native",
+    languages=["Python", "Go"],
+    created_after="2020-01-01",
+    pushed_after="2023-01-01",
+)
+
+for repo in repos[:5]:
+    print(f"- {repo.full_name} ({repo.stars} stars)")
+```
+
+### Clone Repositories
+
+```python
+from greenmining import fetch_repositories, clone_repositories
+
+repos = fetch_repositories(github_token="your_token", max_repos=10, keywords="android")
+
+# Clone into ./greenmining_repos/ with sanitized directory names
+paths = clone_repositories(repos)
+print(f"Cloned {len(paths)} repositories")
+```
+
+### Analyze Repositories by URL
+
+```python
+from greenmining import analyze_repositories
+
+results = analyze_repositories(
+    urls=[
+        "https://github.com/kubernetes/kubernetes",
+        "https://github.com/istio/istio",
+    ],
+    max_commits=100,
+    parallel_workers=2,
+    energy_tracking=True,
+    energy_backend="auto",
+    method_level_analysis=True,
+    include_source_code=True,
+    github_token="your_token",
+    since_date="2020-01-01",
+    to_date="2025-12-31",
+)
+
+for result in results:
+    print(f"{result.name}: {result.green_commit_rate:.1%} green")
+```
+
+### Access Pattern Data
+
+```python
+from greenmining import GSF_PATTERNS
+
+# Get patterns by category
+cloud = {k: v for k, v in GSF_PATTERNS.items() if v['category'] == 'cloud'}
+print(f"Cloud patterns: {len(cloud)}")
+
+# All categories
+categories = set(p['category'] for p in GSF_PATTERNS.values())
+print(f"Categories: {sorted(categories)}")
+```
+
+### Energy Measurement
+
+```python
+from greenmining.energy import get_energy_meter, CPUEnergyMeter
+
+# Auto-detect best backend
+meter = get_energy_meter("auto")
+meter.start()
+# ... your workload ...
+result = meter.stop()
+print(f"Energy: {result.joules:.2f} J, Power: {result.watts_avg:.2f} W")
+```
+
+### Statistical Analysis
+
+```python
+from greenmining.analyzers import StatisticalAnalyzer, TemporalAnalyzer
+
+stat = StatisticalAnalyzer()
+temporal = TemporalAnalyzer(granularity="quarter")
+
+# Pattern correlations, effect sizes, temporal trends
+# See experiment notebook for full usage
+```
+
+### Metrics-to-Power Correlation
+
+```python
+from greenmining.analyzers import MetricsPowerCorrelator
+
+correlator = MetricsPowerCorrelator()
+correlator.fit(
+    metrics=["complexity", "nloc", "code_churn"],
+    metrics_values={
+        "complexity": [10, 20, 30, 40],
+        "nloc": [100, 200, 300, 400],
+        "code_churn": [50, 100, 150, 200],
+    },
+    power_measurements=[5.0, 8.0, 12.0, 15.0],
+)
+print(f"Feature importance: {correlator.feature_importance}")
+```
+
+## Features
+
+### Core Capabilities
+
+- **Pattern Detection**: 124 sustainability patterns across 15 categories from the GSF catalog
+- **Keyword Analysis**: 332 green software detection keywords
+- **Repository Fetching**: GraphQL API with date, star, and language filters
+- **Repository Cloning**: Sanitized directory names in `./greenmining_repos/`
+- **URL-Based Analysis**: Direct Git-based analysis from GitHub URLs (HTTPS and SSH)
+- **Batch Processing**: Parallel analysis of multiple repositories
+- **Private Repository Support**: Authentication via SSH keys or GitHub tokens
+
+### Analysis & Measurement
+
+- **Energy Measurement**: RAPL, CodeCarbon, and CPU Energy Meter backends
+- **Carbon Footprint Reporting**: CO2 emissions with 20+ country profiles (AWS, GCP, Azure)
+- **Metrics-to-Power Correlation**: Pearson and Spearman analysis between code metrics and power
+- **Method-Level Analysis**: Per-method complexity metrics via Lizard integration
+- **Source Code Access**: Before/after source code for refactoring detection
+- **Process Metrics**: DMM size, complexity, interfacing via PyDriller
+- **Statistical Analysis**: Correlations, effect sizes, and temporal trends
+- **Multi-format Output**: JSON, CSV, pandas DataFrame
+
+### Energy Backends
+
+| Backend | Platform | Metrics | Requirements |
+|---------|----------|---------|--------------|
+| **RAPL** | Linux (Intel/AMD) | CPU/RAM energy (Joules) | `/sys/class/powercap/` access |
+| **CodeCarbon** | Cross-platform | Energy + Carbon emissions (gCO2) | `pip install codecarbon` |
+| **CPU Meter** | All platforms | Estimated CPU energy (Joules) | Optional: `pip install psutil` |
+| **Auto** | All platforms | Best available backend | Automatic detection |
+
+### GSF Pattern Categories
+
+**124 patterns across 15 categories:**
+
+| Category | Patterns | Examples |
+|----------|----------|----------|
+| Cloud | 42 | Auto-scaling, serverless, right-sizing, region selection |
+| Web | 17 | CDN, caching, lazy loading, compression |
+| AI/ML | 19 | Model pruning, quantization, edge inference |
+| Database | 5 | Indexing, query optimization, connection pooling |
+| Networking | 8 | Protocol optimization, HTTP/2, gRPC |
+| Network | 6 | Request batching, GraphQL, circuit breakers |
+| Microservices | 4 | Service decomposition, graceful shutdown |
+| Infrastructure | 4 | Alpine containers, IaC, renewable regions |
+| General | 8 | Feature flags, precomputation, background jobs |
+| Others | 11 | Caching, resource, data, async, code, monitoring |
+
+## Development
+
+```bash
+git clone https://github.com/adam-bouafia/greenmining.git
+cd greenmining
+pip install -e ".[dev]"
+
+pytest tests/
+black greenmining/ tests/
+ruff check greenmining/ tests/
+```
+
+## Requirements
+
+- Python 3.9+
+- PyGithub, PyDriller, pandas, colorama, tqdm
+
+**Optional:**
+
+```bash
+pip install greenmining[energy]      # psutil, codecarbon
+pip install greenmining[dev]         # pytest, black, ruff, mypy
+```
+
+## License
+
+MIT License - See [LICENSE](LICENSE) for details.
+
+## Links
+
+- **GitHub**: https://github.com/adam-bouafia/greenmining
+- **PyPI**: https://pypi.org/project/greenmining/
+- **Documentation**: https://greenmining.readthedocs.io/
+- **Docker Hub**: https://hub.docker.com/r/adambouafia/greenmining

greenmining-1.2.0/README.md

@@ -0,0 +1,254 @@
+# greenmining
+
+An empirical Python library for Mining Software Repositories (MSR) in Green IT research.
+
+[![PyPI](https://img.shields.io/pypi/v/greenmining)](https://pypi.org/project/greenmining/)
+[![Python](https://img.shields.io/pypi/pyversions/greenmining)](https://pypi.org/project/greenmining/)
+[![License](https://img.shields.io/github/license/adam-bouafia/greenmining)](LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-readthedocs-blue)](https://greenmining.readthedocs.io/)
+
+## Overview
+
+`greenmining` is a research-grade Python library designed for **empirical Mining Software Repositories (MSR)** studies in **Green IT**. It enables researchers and practitioners to:
+
+- **Mine repositories at scale** - Search, fetch, and clone GitHub repositories via GraphQL API with configurable filters
+- **Classify green commits** - Detect 124 sustainability patterns from the Green Software Foundation (GSF) catalog using 332 keywords
+- **Analyze any repository by URL** - Direct Git-based analysis with support for private repositories
+- **Measure energy consumption** - RAPL, CodeCarbon, and CPU Energy Meter backends for power profiling
+- **Carbon footprint reporting** - CO2 emissions calculation with 20+ country profiles and cloud region support
+- **Method-level analysis** - Per-method complexity and metrics via Lizard integration
+- **Generate research datasets** - Statistical analysis, temporal trends, and publication-ready reports
+
+## Installation
+
+### Via pip
+
+```bash
+pip install greenmining
+```
+
+### With energy measurement
+
+```bash
+pip install greenmining[energy]
+```
+
+### From source
+
+```bash
+git clone https://github.com/adam-bouafia/greenmining.git
+cd greenmining
+pip install -e .
+```
+
+## Quick Start
+
+### Pattern Detection
+
+```python
+from greenmining import GSF_PATTERNS, is_green_aware, get_pattern_by_keywords
+
+print(f"Total patterns: {len(GSF_PATTERNS)}")  # 124 patterns across 15 categories
+
+commit_msg = "Optimize Redis caching to reduce energy consumption"
+if is_green_aware(commit_msg):
+    patterns = get_pattern_by_keywords(commit_msg)
+    print(f"Matched patterns: {patterns}")
+```
+
+### Fetch Repositories
+
+```python
+from greenmining import fetch_repositories
+
+repos = fetch_repositories(
+    github_token="your_token",
+    max_repos=50,
+    min_stars=500,
+    keywords="kubernetes cloud-native",
+    languages=["Python", "Go"],
+    created_after="2020-01-01",
+    pushed_after="2023-01-01",
+)
+
+for repo in repos[:5]:
+    print(f"- {repo.full_name} ({repo.stars} stars)")
+```
+
+### Clone Repositories
+
+```python
+from greenmining import fetch_repositories, clone_repositories
+
+repos = fetch_repositories(github_token="your_token", max_repos=10, keywords="android")
+
+# Clone into ./greenmining_repos/ with sanitized directory names
+paths = clone_repositories(repos)
+print(f"Cloned {len(paths)} repositories")
+```
+
+### Analyze Repositories by URL
+
+```python
+from greenmining import analyze_repositories
+
+results = analyze_repositories(
+    urls=[
+        "https://github.com/kubernetes/kubernetes",
+        "https://github.com/istio/istio",
+    ],
+    max_commits=100,
+    parallel_workers=2,
+    energy_tracking=True,
+    energy_backend="auto",
+    method_level_analysis=True,
+    include_source_code=True,
+    github_token="your_token",
+    since_date="2020-01-01",
+    to_date="2025-12-31",
+)
+
+for result in results:
+    print(f"{result.name}: {result.green_commit_rate:.1%} green")
+```
+
+### Access Pattern Data
+
+```python
+from greenmining import GSF_PATTERNS
+
+# Get patterns by category
+cloud = {k: v for k, v in GSF_PATTERNS.items() if v['category'] == 'cloud'}
+print(f"Cloud patterns: {len(cloud)}")
+
+# All categories
+categories = set(p['category'] for p in GSF_PATTERNS.values())
+print(f"Categories: {sorted(categories)}")
+```
+
+### Energy Measurement
+
+```python
+from greenmining.energy import get_energy_meter, CPUEnergyMeter
+
+# Auto-detect best backend
+meter = get_energy_meter("auto")
+meter.start()
+# ... your workload ...
+result = meter.stop()
+print(f"Energy: {result.joules:.2f} J, Power: {result.watts_avg:.2f} W")
+```
+
+### Statistical Analysis
+
+```python
+from greenmining.analyzers import StatisticalAnalyzer, TemporalAnalyzer
+
+stat = StatisticalAnalyzer()
+temporal = TemporalAnalyzer(granularity="quarter")
+
+# Pattern correlations, effect sizes, temporal trends
+# See experiment notebook for full usage
+```
+
+### Metrics-to-Power Correlation
+
+```python
+from greenmining.analyzers import MetricsPowerCorrelator
+
+correlator = MetricsPowerCorrelator()
+correlator.fit(
+    metrics=["complexity", "nloc", "code_churn"],
+    metrics_values={
+        "complexity": [10, 20, 30, 40],
+        "nloc": [100, 200, 300, 400],
+        "code_churn": [50, 100, 150, 200],
+    },
+    power_measurements=[5.0, 8.0, 12.0, 15.0],
+)
+print(f"Feature importance: {correlator.feature_importance}")
+```
+
+## Features
+
+### Core Capabilities
+
+- **Pattern Detection**: 124 sustainability patterns across 15 categories from the GSF catalog
+- **Keyword Analysis**: 332 green software detection keywords
+- **Repository Fetching**: GraphQL API with date, star, and language filters
+- **Repository Cloning**: Sanitized directory names in `./greenmining_repos/`
+- **URL-Based Analysis**: Direct Git-based analysis from GitHub URLs (HTTPS and SSH)
+- **Batch Processing**: Parallel analysis of multiple repositories
+- **Private Repository Support**: Authentication via SSH keys or GitHub tokens
+
+### Analysis & Measurement
+
+- **Energy Measurement**: RAPL, CodeCarbon, and CPU Energy Meter backends
+- **Carbon Footprint Reporting**: CO2 emissions with 20+ country profiles (AWS, GCP, Azure)
+- **Metrics-to-Power Correlation**: Pearson and Spearman analysis between code metrics and power
+- **Method-Level Analysis**: Per-method complexity metrics via Lizard integration
+- **Source Code Access**: Before/after source code for refactoring detection
+- **Process Metrics**: DMM size, complexity, interfacing via PyDriller
+- **Statistical Analysis**: Correlations, effect sizes, and temporal trends
+- **Multi-format Output**: JSON, CSV, pandas DataFrame
+
+### Energy Backends
+
+| Backend | Platform | Metrics | Requirements |
+|---------|----------|---------|--------------|
+| **RAPL** | Linux (Intel/AMD) | CPU/RAM energy (Joules) | `/sys/class/powercap/` access |
+| **CodeCarbon** | Cross-platform | Energy + Carbon emissions (gCO2) | `pip install codecarbon` |
+| **CPU Meter** | All platforms | Estimated CPU energy (Joules) | Optional: `pip install psutil` |
+| **Auto** | All platforms | Best available backend | Automatic detection |
+
+### GSF Pattern Categories
+
+**124 patterns across 15 categories:**
+
+| Category | Patterns | Examples |
+|----------|----------|----------|
+| Cloud | 42 | Auto-scaling, serverless, right-sizing, region selection |
+| Web | 17 | CDN, caching, lazy loading, compression |
+| AI/ML | 19 | Model pruning, quantization, edge inference |
+| Database | 5 | Indexing, query optimization, connection pooling |
+| Networking | 8 | Protocol optimization, HTTP/2, gRPC |
+| Network | 6 | Request batching, GraphQL, circuit breakers |
+| Microservices | 4 | Service decomposition, graceful shutdown |
+| Infrastructure | 4 | Alpine containers, IaC, renewable regions |
+| General | 8 | Feature flags, precomputation, background jobs |
+| Others | 11 | Caching, resource, data, async, code, monitoring |
+
+## Development
+
+```bash
+git clone https://github.com/adam-bouafia/greenmining.git
+cd greenmining
+pip install -e ".[dev]"
+
+pytest tests/
+black greenmining/ tests/
+ruff check greenmining/ tests/
+```
+
+## Requirements
+
+- Python 3.9+
+- PyGithub, PyDriller, pandas, colorama, tqdm
+
+**Optional:**
+
+```bash
+pip install greenmining[energy]      # psutil, codecarbon
+pip install greenmining[dev]         # pytest, black, ruff, mypy
+```
+
+## License
+
+MIT License - See [LICENSE](LICENSE) for details.
+
+## Links
+
+- **GitHub**: https://github.com/adam-bouafia/greenmining
+- **PyPI**: https://pypi.org/project/greenmining/
+- **Documentation**: https://greenmining.readthedocs.io/
+- **Docker Hub**: https://hub.docker.com/r/adambouafia/greenmining