git-ember 1.2.0__py3-none-any.whl

git_ember-1.2.0.dist-info/METADATA

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: git-ember
+Version: 1.2.0
+Summary: A GitHub-style heatmap of commits for your terminal
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: ruff>=0.15.9
+
+# git-ember
+
+A GitHub-style heatmap of commit activity for your terminal.
+
+## Overview
+
+`git-ember` displays a colored grid representing commit activity over time, similar to the contribution graph shown on GitHub profiles. It reads directly from your local Git history—no external APIs or network requests required.
+
+The tool supports multiple color schemes, branch filtering, custom date ranges, and can display repository statistics, recent commits, and top contributors.
+
+## Prerequisites
+
+- Python 3.11 or higher
+- Git installed and available in PATH
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone https://codeberg.org/lukavr05/git-ember.git
+cd git-ember
+```
+
+
+### Running without installation
+
+```bash
+PYTHONPATH=src python3 main.py .
+```
+
+## Configuration
+
+git-ember reads configuration from `~/.config/git-ember/config.toml`. CLI arguments take precedence over config values.
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `color` | No | `green` | Color scheme name |
+| `border` | No | `=` | Border character |
+
+## Usage
+
+Show commit heatmap for the current year:
+
+```bash
+git-ember
+```
+
+Show heatmap for a specific repository:
+
+```bash
+git-ember /path/to/repo
+```
+
+Show multiple years:
+
+```bash
+git-ember --years 2
+git-ember -y 3
+```
+
+Use different color schemes:
+
+```bash
+git-ember --color blue
+git-ember --color orange
+git-ember --color purple
+git-ember --color mono
+```
+
+Show heatmap for a specific branch:
+
+```bash
+git-ember --branch feature-x
+```
+
+Display branch tree visualization:
+
+```bash
+git-ember --tree
+git-ember --branch feature-x --tree
+```
+
+Show custom date range:
+
+```bash
+git-ember --after 2025-01-01 --before 2025-06-30
+git-ember --after 2025-01-01
+```
+
+Show extended report with recent commits and top contributors:
+
+```bash
+git-ember --extended
+git-ember -e
+```
+
+Show repository statistics:
+
+```bash
+git-ember --stats
+git-ember -S
+```
+
+### Command-line options
+
+| Flag | Alias | Description | Default |
+|------|-------|-------------|---------|
+| `--color` | `-c` | Color scheme | `green` |
+| `--years` | `-y` | Number of years to show | `1` |
+| `--border` | `-b` | Border character | `=` |
+| `--extended` | `-e` | Show recent commits and top contributors | `false` |
+| `--stats` | `-S` | Show repository statistics | `false` |
+| `--ascii` | `-a` | Use ASCII characters instead of Unicode | `false` |
+| `--compact` | - | Show last 4 months only | `false` |
+| `--branch` | - | Show heatmap for specific branch | all branches |
+| `--tree` | `-t` | Show branch tree under heatmap | `false` |
+| `--scale` | - | Intensity scaling: auto or adaptive | `auto` |
+| `--after` | - | Show commits after date (YYYY-MM-DD) | - |
+| `--before` | - | Show commits before date (YYYY-MM-DD) | - |
+| `--version` | `-V` | Show version | - |
+| `--help` | `-h` | Show help | - |
+
+## Project Structure
+
+```
+git-ember/
+├── main.py                 # Entry point
+├── pyproject.toml         # Package configuration
+├── Makefile              # Build targets
+├── .python-version       # Python version (3.11)
+├── README.md            # This file
+├── docs/
+│   ├── CHANGELOG.md    # Version history
+│   └── PLAN.md         # Feature planning
+└── src/
+    └── githeat/
+        ├── __init__.py   # Package version
+        ├── cli.py        # CLI argument parsing and config
+        ├── git.py        # Git command execution and parsing
+        ├── render.py     # Grid and branch tree rendering
+        └── colors.py     # ANSI color scheme definitions
+```
+
+## Development
+
+Run the linter:
+
+```bash
+make lint
+```
+
+> ⚠️ Note: No test suite exists currently.
+
+## License
+
+No LICENSE file exists in this repository.

git_ember-1.2.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+gitember/__init__.py,sha256=MpAT5hgNoHnTtG1XRD_GV_A7QrHVU6vJjGSw_8qMGA4,22
+gitember/cli.py,sha256=lfK87jtzweUyMOkFhYBw3_m3g8IdKw3ugw1aY5DdVIc,11764
+gitember/colors.py,sha256=v5bHcCj9pdSqcieG3X-WzeSgsLVpLtNsSbf-eEHvZGY,3344
+gitember/git.py,sha256=8YpoAml6bFumCN3hoNmqdv-YVX-XbbTpwu4_rWwuwXI,14303
+gitember/render.py,sha256=zadIVrKCIXaaE6rDi23So656rvrH36qNqxGhgM8angk,8691
+git_ember-1.2.0.dist-info/METADATA,sha256=tQk4rqXb6xt19NUtr_DUTd8IWfLffyvrJaf8bW_iNUM,3978
+git_ember-1.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+git_ember-1.2.0.dist-info/entry_points.txt,sha256=-IiSHTFzrEdM25fuz-psxq-U24lv7XWCZ2tOpHpHk2s,48
+git_ember-1.2.0.dist-info/top_level.txt,sha256=VEJk48Zmg73VytgvOKH_qeGSq6GGADX5-fjFElHBNPY,9
+git_ember-1.2.0.dist-info/RECORD,,

git_ember-1.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

git_ember-1.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+git-ember = gitember.cli:main

git_ember-1.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gitember

gitember/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.2.0"

gitember/cli.py

@@ -0,0 +1,414 @@
+import argparse
+import calendar
+import datetime as dt
+import os
+import sys
+import time
+from pathlib import Path
+
+from githeat import __version__
+from githeat.colors import get_color_scheme, RESET, LIGHT_GRAY
+from githeat.git import (
+    run_git_log,
+    get_recent_commits,
+    get_top_contributors,
+    get_repo_stats,
+    get_branches,
+    get_branch_tree,
+    get_default_branch,
+    get_streaks,
+)
+from githeat.render import render_grid, render_branch_tree, calculate_thresholds
+
+
+def config_file_path() -> Path:
+    """Get the path to the config file.
+
+    Returns:
+        Path to config.toml in platform-specific config directory.
+    """
+    if sys.platform.startswith("win"):
+        base = os.getenv("APPDATA")
+        if base:
+            base_path = Path(base)
+        else:
+            base_path = Path.home() / "AppData" / "Roaming"
+    else:
+        xdg = os.getenv("XDG_CONFIG_HOME")
+        if xdg:
+            base_path = Path(xdg)
+        else:
+            base_path = Path.home() / ".config"
+    return base_path / "git-ember" / "config.toml"
+
+
+ALLOWED_CONFIG_KEYS = {"color", "border"}
+# NOTE: branch is intentionally excluded from config to avoid user confusion
+
+
+def load_config() -> dict:
+    """Load config from file, returning defaults if not exists.
+
+    Returns:
+        Dict with keys: color, border.
+    """
+    path = config_file_path()
+    if not path.exists():
+        return {
+            "color": "green",
+            "border": "=",
+        }
+
+    config = {"color": "green", "border": "="}
+    try:
+        text = path.read_text(encoding="utf-8")
+    except OSError:
+        return config
+
+    # Simple TOML-like parsing: key=value, ignore comments
+    for line in text.splitlines():
+        stripped = line.strip()
+        # Skip empty lines and comments
+        if not stripped or stripped.startswith("#"):
+            continue
+        if "=" in stripped:
+            key, _, value = stripped.partition("=")
+            key = key.strip()
+            # Strip quotes from value - handles both "value" and 'value'
+            value = value.strip().strip('"').strip("'")
+            # Only allow predefined keys (whitelist for security)
+            if key in ALLOWED_CONFIG_KEYS:
+                config[key] = value
+    return config
+
+
+def save_config(config: dict) -> None:
+    """Save config to file.
+
+    Args:
+        config: Dict with keys: week_start, style, color, border.
+    """
+    path = config_file_path()
+    try:
+        path.parent.mkdir(parents=True, exist_ok=True)
+        lines = []
+        for k, v in config.items():
+            if k in ALLOWED_CONFIG_KEYS:
+                escaped = v.replace('"', '\\"')
+                lines.append(f'{k} = "{escaped}"')
+        path.write_text("\n".join(lines), encoding="utf-8")
+    except OSError:
+        pass
+
+
+def parse_args() -> argparse.Namespace:
+    """Parse command line arguments.
+
+    Returns:
+        Parsed arguments namespace.
+    """
+    parser = argparse.ArgumentParser(
+        description="Display a GitHub-style heatmap of commits in your terminal.",
+    )
+    parser.add_argument(
+        "path",
+        nargs="?",
+        default=".",
+        help="Path to git repository (default: current directory)",
+    )
+    parser.add_argument(
+        "--color",
+        "-c",
+        choices=[
+            "green",
+            "blue",
+            "orange",
+            "purple",
+            "red",
+            "yellow",
+            "teal",
+            "pink",
+            "aqua",
+            "mono",
+        ],
+        help="Color scheme",
+    )
+    parser.add_argument(
+        "--years",
+        "-y",
+        type=int,
+        default=1,
+        help="Number of years to show (default: 1)",
+    )
+    parser.add_argument(
+        "--border",
+        "-b",
+        type=str,
+        default="=",
+        help="Border character (default: =)",
+    )
+    parser.add_argument(
+        "--extended",
+        "-e",
+        action="store_true",
+        help="Show extended report with recent commits and top contributors",
+    )
+    parser.add_argument(
+        "--stats",
+        "-S",
+        action="store_true",
+        help="Show repository statistics (total commits, authors, dates)",
+    )
+    parser.add_argument(
+        "--ascii",
+        "-a",
+        action="store_true",
+        help="Use ASCII characters instead of Unicode blocks",
+    )
+    parser.add_argument(
+        "--compact",
+        action="store_true",
+        help="Only show months up to the current month",
+    )
+    parser.add_argument(
+        "--branch",
+        action="store",
+        help="Show heatmap for specific branch instead of all branches",
+    )
+    parser.add_argument(
+        "--tree",
+        "-t",
+        action="store_true",
+        help="Show branch tree under heatmap",
+    )
+    parser.add_argument(
+        "--scale",
+        type=str,
+        choices=["auto", "adaptive"],
+        default="auto",
+        help="Intensity scaling mode: auto or adaptive (default: auto)",
+    )
+    parser.add_argument(
+        "--after",
+        type=str,
+        help="Show commits after this date (YYYY-MM-DD)",
+    )
+    parser.add_argument(
+        "--before",
+        type=str,
+        help="Show commits before this date (YYYY-MM-DD)",
+    )
+    parser.add_argument(
+        "--version",
+        "-V",
+        action="version",
+        version=f"git-ember {__version__}",
+    )
+    return parser.parse_args()
+
+
+def get_repo_path(path: str) -> str:
+    """Resolve path to absolute path.
+
+    Args:
+        path: Relative or absolute path to git repository.
+
+    Returns:
+        Absolute path as string.
+
+    Raises:
+        ValueError: If path is unsafe (contains suspicious characters).
+    """
+    if not path:
+        raise ValueError("Path cannot be empty")
+
+    import re
+
+    if re.search(r"[;&|`$()]", path):
+        raise ValueError(f"Invalid characters in path: {path}")
+
+    resolved = Path(path).resolve()
+
+    return str(resolved)
+
+
+def main() -> None:
+    """Main entry point."""
+    args = parse_args()
+    repo_path = get_repo_path(args.path)
+
+    config = load_config()
+
+    color_name = args.color or config.get("color", "green")
+    years = args.years
+    border_char = args.border[0] if args.border else "="  # prevent escape codes
+    ascii_mode = args.ascii
+    branch = args.branch
+
+    if branch:
+        valid_branches = get_branches(repo_path)
+        if branch not in valid_branches:
+            print(f"Error: Branch '{branch}' not found")
+            sys.exit(1)
+
+    if args.color is not None:
+        new_config = config.copy()
+        if args.color:
+            new_config["color"] = args.color
+        save_config(new_config)
+
+    color_scheme = get_color_scheme(color_name)
+
+    today = dt.date.today()
+    output_parts = []
+    extended = args.extended
+    compact = args.compact
+    scale_mode = args.scale
+
+    custom_range = args.after or args.before
+
+    if args.after:
+        try:
+            start_date = dt.date.fromisoformat(args.after)
+        except ValueError:
+            print("Error: Invalid --after date. Use YYYY-MM-DD format.")
+            sys.exit(1)
+    if args.before:
+        try:
+            end_date = dt.date.fromisoformat(args.before)
+        except ValueError:
+            print("Error: Invalid --before date. Use YYYY-MM-DD format.")
+            sys.exit(1)
+
+    if custom_range:
+        num_iterations = 1
+    else:
+        num_iterations = years
+
+    for i in range(num_iterations):
+        if custom_range:
+            pass
+        else:
+            year = today.year - i
+            current_month = today.month
+
+            if compact and i == 0:
+                start_month = max(1, current_month - 3)
+                start_date = dt.date(year, start_month, 1)
+                end_date = dt.date(
+                    year, current_month, calendar.monthrange(year, current_month)[1]
+                )
+            else:
+                start_date = dt.date(year, 1, 1)
+                end_date = dt.date(year, 12, 31)
+
+        try:
+            counts = run_git_log(start_date, end_date, repo_path, branch=branch)
+        except ValueError as e:
+            print(f"Error: {e}")
+            sys.exit(1)
+
+        thresholds = calculate_thresholds(counts, scale_mode)
+
+        heatmap = render_grid(
+            start_date,
+            end_date,
+            counts,
+            color_scheme,
+            "sunday",
+            border_char,
+            ascii_mode,
+            thresholds=thresholds,
+        )
+
+        if custom_range:
+            output_parts.append(heatmap)
+        elif num_iterations > 1:
+            output_parts.append(f"[{year}]\n{heatmap}")
+        else:
+            output_parts.append(heatmap)
+
+    output_parts.reverse()
+    print("\n" + "\n".join(output_parts))
+
+    if args.tree:
+        tree_commits = get_branch_tree(repo_path, branch=branch)
+        default_branch = get_default_branch(repo_path)
+        tree_output = render_branch_tree(
+            tree_commits,
+            default_branch=default_branch,
+            selected_branch=branch,
+            color_scheme=color_scheme,
+            ascii_mode=ascii_mode,
+            compact=args.compact,
+        )
+        if tree_output:
+            print(tree_output)
+
+    show_stats = args.stats or extended
+
+    if show_stats:
+        stats = get_repo_stats(repo_path, branch=branch)
+
+        print("\n--- Statistics ---")
+        print(f"  Total commits:  {stats.get('total_commits', 0)}")
+        print(f"  Authors:        {stats.get('num_authors', 0)}")
+
+        first_commit_date = stats.get("first_commit_date", "")
+        if first_commit_date:
+            print(f"  First commit:   {first_commit_date}")
+
+        last_commit_date = stats.get("last_commit_date", "")
+        if last_commit_date:
+            print(f"  Last commit:    {last_commit_date}")
+
+        streak_start_date = dt.date.today() - dt.timedelta(days=years * 365)
+        streak_end_date = dt.date.today()
+        streak_counts = run_git_log(
+            streak_start_date, streak_end_date, repo_path, branch=branch
+        )
+        streaks = get_streaks(streak_counts)
+
+        if streaks["current_streak"] > 0:
+            print(f"  Current streak: {streaks['current_streak']} days")
+
+        if streaks["longest_streak"] > 0:
+            longest_end = streaks["longest_streak_end"]
+            if longest_end:
+                month_name = longest_end.strftime("%b %Y")
+                print(
+                    f"  Longest streak: {streaks['longest_streak']} days ({month_name})"
+                )
+            else:
+                print(f"  Longest streak: {streaks['longest_streak']} days")
+
+    if extended:
+        print("\n--- Recent Commits ---")
+        for commit in get_recent_commits(repo_path, branch=branch):
+            commit_color = color_scheme.get(3)
+            author_color = color_scheme.get(2)
+
+            commit_time = (
+                time.strftime("%H:%M", time.localtime(int(commit["timestamp"])))
+                if commit["timestamp"]
+                else ""
+            )
+            date_parts = commit["date"].split("-")
+            formatted_date = (
+                f"{date_parts[2]}-{date_parts[1]}-{date_parts[0]}"
+                if len(date_parts) == 3
+                else commit["date"]
+            )
+            print(
+                f"  {commit_color}{commit['hash']}{RESET} | {author_color}{commit['author']}{RESET} | {LIGHT_GRAY}{formatted_date} {commit_time}{RESET}"
+            )
+            print(f"      {commit['message']}")
+
+        print("\n--- Top Contributors ---")
+        author_color = color_scheme.get(2)
+        for author, count in get_top_contributors(repo_path, branch=branch):
+            print(f"  {count:>4}  {author_color}{author}{RESET}")
+
+
+if __name__ == "__main__":
+    main()