Metadata-Version: 2.4
Name: devaansh-gitscope
Version: 1.0.0
Summary: A read-only Textual TUI for exploring git commit history.
Author: gitscope contributors
License: MIT License
        
        Copyright (c) 2026 DevaanshPathak
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: textual>=1.0
Dynamic: license-file

# gitscope

![gitscope banner](banner.png)

gitscope is a read-only terminal UI for exploring git commit history: log rows, branch topology, refs, and selected-commit diffs in one local view. It exists as a focused personal/portfolio project for making history easier to scan without adding git workflow actions.

## Features

- Scrollable commit log for the current branch/HEAD or all branches, including SHA, author, date, and subject.
- ASCII/Unicode branch graph gutter aligned with the log, including branch lanes and merge topology.
- Scrollable line-level diff pane that updates when the selected commit changes.
- Branch/ref sidebar for local branches, tags, and HEAD.
- Status bar showing the repository path, current HEAD, and key hints.
- Incremental history loading so startup is bounded by the first page of commits.
- Read-only by design: no staging, committing, rebasing, checkout, push, pull, or fetch operations.

## Installation

Prerequisites:

- Python 3.12+
- A local `git` binary available on `PATH`
- A git repository already present on disk

Install from PyPI:

```bash
python -m pip install devaansh-gitscope
```

The installed command is still `gitscope`.

Install from source:

```bash
git clone <repo-url>
cd gitscope
python -m pip install .
```

For local development:

```bash
python -m pip install -e .
python -m pytest
```

## Usage

Run `gitscope` from inside a git repository:

```bash
cd path/to/repo
gitscope
```

Current bindings:

- `q`: quit
- `r`: refresh
- `m`: load more commits
- `a`: show all local branches
- `h`: show HEAD
- `Up` / `Down` or `j` / `k`: move the selected commit
- `PgUp` / `PgDn`: scroll the focused pane
- `Tab`: switch focus
- `?`: show help text

## Status

gitscope is early and actively developed. The v1 path is focused on a local, read-only commit history viewer with source installation, bounded history loading, refs, graph, diff, and status panes working together.

Known v1 limitations:

- Line-level diffs only; no word-level intraline highlighting.
- No config files, custom themes, or plugin system.
- No remote/network features and no mutating git operations.
