Metadata-Version: 2.4
Name: gitww
Version: 0.1.3
Summary: interactive git heatmap tooling assistant
Author-email: Jongya <jongya26@gmail.com>
License: MIT
License-File: LICENSE
Keywords: commit,git,heatmap,history,metadata
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Python: >=3.11
Requires-Dist: prompt-toolkit>=3.0
Requires-Dist: pyfiglet>=1.0.4
Provides-Extra: dev
Requires-Dist: pytest>=9.0.3; extra == 'dev'
Description-Content-Type: text/markdown

# gitww

`gitww` is an interactive git heatmap tooling assistant.

## Quick start

1. Open a git repository you want to inspect or rewrite.
2. Install `gitww` with `uv`:

```bash
uv tool install gitww
```

If you want to work from a local checkout instead, install the project dependencies:

```bash
uv sync --extra dev
```

3. Start the CLI from that repository root:

```bash
uv run gitww
```

The shell uses the current directory as the repository and prompts for the branch to use, defaulting to the branch currently checked out in that directory.

## Documentation

Detailed usage, configuration examples, strategies, and publishing notes are in:

[`documentations/gitww.md`](documentations/gitww.md)

Release instructions for publishing `gitww` to PyPI are in:

[`documentations/release.md`](documentations/release.md)
