Initial commit: EFECT repository

Author: timbencker

.github/scripts/generate_coverage.py

@@ -0,0 +1,131 @@
+#!/usr/bin/env python3
+"""
+Generate coverage report HTML and update README.md
+"""
+import os
+import re
+import csv
+from pathlib import Path
+from collections import defaultdict
+
+def count_rule_cards():
+    """Count total rule cards and unverified ones"""
+    rule_cards_dir = Path("rule_cards")
+    total = 0
+    unverified = 0
+    
+    for mdc_file in rule_cards_dir.glob("*.mdc"):
+        # Skip the spec file
+        if mdc_file.name == "SPEC_RuleCard_v1.mdc":
+            continue
+        
+        total += 1
+        
+        # Read file and check research_verified
+        try:
+            content = mdc_file.read_text(encoding='utf-8')
+            # Look for research_verified: no (case-insensitive)
+            if re.search(r'research_verified:\s*no', content, re.IGNORECASE):
+                unverified += 1
+        except Exception as e:
+            print(f"Error reading {mdc_file}: {e}")
+    
+    return total, unverified
+
+def count_research_by_module():
+    """Count research techniques by module_title from CSV"""
+    csv_path = Path("research/research_all_techniques.csv")
+    module_counts = defaultdict(int)
+    
+    if not csv_path.exists():
+        print(f"Warning: {csv_path} not found")
+        return module_counts
+    
+    try:
+        with open(csv_path, 'r', encoding='utf-8') as f:
+            reader = csv.DictReader(f)
+            for row in reader:
+                module_title = row.get('module_title', '').strip()
+                if module_title:
+                    module_counts[module_title] += 1
+    except Exception as e:
+        print(f"Error reading CSV: {e}")
+    
+    return module_counts
+
+def generate_html(total_rules, unverified_rules, module_counts):
+    """Generate HTML coverage report"""
+    verified_rules = total_rules - unverified_rules
+    
+    # Calculate coverage percentage (placeholder for now)
+    coverage_pct = 0
+    
+    html = f"""<!-- COVERAGE:START -->
+
+Coverage: {coverage_pct}%
+
+<h3>Manually verified:</h3>
+
+<p><strong>Rules:</strong> {verified_rules}/{total_rules} (based on yaml research_verified: no)</p>
+
+<p><strong>Research:</strong> (based on research_all_techniques.csv)</p>
+<ul>
+"""
+    
+    # Sort modules by title for consistent output
+    for module_title in sorted(module_counts.keys()):
+        count = module_counts[module_title]
+        html += f"  <li>{module_title}: 0/{count}</li>\n"
+    
+    html += """</ul>
+
+<!-- COVERAGE:END -->"""
+    
+    return html
+
+def update_readme(html_content):
+    """Update README.md with coverage report"""
+    readme_path = Path("README.md")
+    
+    if not readme_path.exists():
+        print("Warning: README.md not found, creating it")
+        readme_path.write_text(f"# EFECT\n\n{html_content}\n", encoding='utf-8')
+        return
+    
+    content = readme_path.read_text(encoding='utf-8')
+    
+    # Pattern to match the coverage section
+    pattern = r'<!-- COVERAGE:START -->.*?<!-- COVERAGE:END -->'
+    
+    if re.search(pattern, content, re.DOTALL):
+        # Replace existing coverage section
+        content = re.sub(pattern, html_content, content, flags=re.DOTALL)
+    else:
+        # Append to end of file
+        content += f"\n\n{html_content}\n"
+    
+    readme_path.write_text(content, encoding='utf-8')
+    print("Updated README.md with coverage report")
+
+def main():
+    print("Generating coverage report...")
+    
+    # Count rule cards
+    total_rules, unverified_rules = count_rule_cards()
+    print(f"Total rules: {total_rules}, Unverified: {unverified_rules}")
+    
+    # Count research by module
+    module_counts = count_research_by_module()
+    print(f"Found {len(module_counts)} modules in research CSV")
+    
+    # Generate HTML
+    html = generate_html(total_rules, unverified_rules, module_counts)
+    
+    # Update README
+    update_readme(html)
+    
+    print("Coverage report generated successfully")
+
+if __name__ == "__main__":
+    main()
+

.github/workflows/coverage-report.yml

@@ -0,0 +1,39 @@
+name: Generate Coverage Report
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Generate Coverage Report
+      run: |
+        python .github/scripts/generate_coverage.py
+    
+    - name: Commit coverage report
+      run: |
+        git config --local user.email "action@github.com"
+        git config --local user.name "GitHub Action"
+        git add README.md
+        if ! git diff --staged --quiet; then
+          git commit -m "Update coverage report [skip ci]"
+          git push
+        else
+          echo "No changes to commit"
+        fi
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.gitignore

@@ -0,0 +1,50 @@
+# OS files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+desktop.ini
+
+# Editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.project
+.classpath
+.settings/
+
+# Temporary files
+*.tmp
+*.log
+*.bak
+*.cache
+
+# Study logs
+# study_logs/logs/*.md
+# study_logs/logs/*.json
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+venv/
+env/
+ENV/
+
+# Node
+node_modules/
+npm-debug.log
+yarn-error.log
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+Contributions are welcome! This is an experimental project, so feel free to:
+
+- **Check sources** or improve existing content
+- **Improve documentation** or examples
+- **Report issues** or suggest improvements
+- **Share your experiments** and findings
+- **Raise issues** if you spot problems, errors, or inconsistencies
+
+## Special Requests
+
+- **Format Migration**: We're planning to migrate from `.mdc` to `.yaml`/`.json` and are open to better system/spec suggestions
+- **Research Fact-Checking**: We're looking for researchers and interested to fact-check files! If you have expertise in ADHD interventions, please help verify the research content.
+
+## How to Contribute
+
+1. Fork the repo
+2. Make your changes
+3. Verify your sources (especially for research content)
+4. Submit a pull request
+
+## Guidelines
+
+- **Verify sources**: If you add research content, make sure sources are traceable
+- **Keep it friendly and respectful**
+- **Test things**: If you add code or scripts, test them
+- **Be clear**: Documentation should be clear and helpful
+
+No formal process - just be respectful and helpful. Questions? Write me or better open an issue.
+
+