Metadata-Version: 2.4
Name: ghostnotes
Version: 1.0.0
Summary: Strip personal annotations from code before committing
Author-email: Tuna Akin <tuna.takin@gmail.com>
License-Expression: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# GhostNotes
**Version:** 1.0.0 | **Last Updated:** April 12, 2026

A Git tool that strips tagged comments before committing.

---

## Installation

```bash
pip install ghostnotes
```

Then initialize in any git repo:

```bash
cd your-project
ghostnotes init
```

---

## What it does
GhostNotes lets you leave personal notes in your code using a tag (default: `GN:`). Before every commit, it automatically strips them out so they never reach your repository.
```python
x = some_function() # GN: this breaks when input is negative, fix later
```
This comment line gets stripped before the commit so it looks like:
```python
x = some_function()
```

Your local file stays untouched.

---

## Commands

| Command | Description |
|---|---|
| `ghostnotes init` | Initialize GhostNotes in the current project |
| `ghostnotes status` | Show all GhostNotes in the current project |
| `ghostnotes set-tag --tag <tag>` | Change the default comment tag |
| `ghostnotes add-lang --ext <.ext> --symb <symbol>` | Add support for a new language |
| `ghostnotes pull` | Git pull that safely strips and re-applies your ghostnotes |
