git-notes-hooks 0.1.0__tar.gz → 0.1.6__tar.gz

git_notes_hooks-0.1.6/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: git-notes-hooks
+Version: 0.1.6
+Summary: Automatic Git hooks to keep refs/notes/* synchronized across all remotes on push and pull
+Author-email: Bimo <i.s41m0011@gmail.com>
+License: MIT OR Apache-2.0
+Project-URL: Homepage, https://github.com/isaim0011/git-notes
+Project-URL: Repository, https://github.com/isaim0011/git-notes
+Project-URL: Issues, https://github.com/isaim0011/git-notes/issues
+Project-URL: Documentation, https://github.com/isaim0011/git-notes#readme
+Project-URL: Changelog, https://github.com/isaim0011/git-notes/blob/main/docs/CHANGELOG.md
+Keywords: git,git-notes,git-hooks,code-review,decentralized,developer-tools
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.1
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+
+# git-notes-hooks
+
+> **Automatic Git hooks to keep `refs/notes/*` seamlessly synchronized across all remotes on every push and pull.**
+
+[![PyPI Version](https://img.shields.io/pypi/v/git-notes-hooks.svg)](https://pypi.org/project/git-notes-hooks/)
+[![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue)](https://github.com/isaim0011/git-notes)
+[![Python Versions](https://img.shields.io/pypi/pyversions/git-notes-hooks.svg)](https://pypi.org/project/git-notes-hooks/)
+
+`git-notes-hooks` provides automated git lifecycle integration for the **[git-notes](https://github.com/isaim0011/git-notes)** ecosystem. It installs zero-friction client-side git hooks into your repositories to ensure decentralized code review comments and notes travel with your commits automatically.
+
+---
+
+## ⚡ Quick Installation
+
+Install from PyPI via pip:
+
+```bash
+pip install git-notes-hooks
+```
+
+Or using pipx:
+
+```bash
+pipx install git-notes-hooks
+```
+
+---
+
+## 🚀 Usage
+
+Navigate to any Git repository and run:
+
+### 1. Install Hooks
+Install the automated push/pull synchronization hooks into `.git/hooks`:
+
+```bash
+git-notes-hooks install
+```
+
+This installs:
+- `post-commit`: Updates local note indices on every commit
+- `pre-push`: Pushes `refs/notes/*` to `origin` whenever you run `git push`
+- `post-merge`: Fetches and merges remote notes from `origin` on `git pull`
+
+### 2. Check Hook Status
+Verify active git-notes hooks in your current repository:
+
+```bash
+git-notes-hooks status
+```
+
+### 3. Uninstall Hooks
+Safely remove git-notes hooks at any time:
+
+```bash
+git-notes-hooks uninstall
+```
+
+---
+
+## 🔒 History-Safe & Non-Destructive
+
+`git-notes-hooks` operates strictly on Git's native note references (`refs/notes/comments`, `refs/notes/review`, `refs/notes/todos`). It **never modifies commit SHAs, git history, or working tree files**.
+
+---
+
+## 🔗 Links & Resources
+
+- **GitHub Repository**: [https://github.com/isaim0011/git-notes](https://github.com/isaim0011/git-notes)
+- **Issue Tracker**: [https://github.com/isaim0011/git-notes/issues](https://github.com/isaim0011/git-notes/issues)
+- **Documentation**: [https://github.com/isaim0011/git-notes/blob/main/docs/ARCHITECTURE.md](https://github.com/isaim0011/git-notes/blob/main/docs/ARCHITECTURE.md)
+- **Release Downloads**: [https://github.com/isaim0011/git-notes/releases](https://github.com/isaim0011/git-notes/releases)
+
+---
+
+## 📄 License
+
+Licensed under either of:
+- Apache License, Version 2.0
+- MIT License
+at your option.

git_notes_hooks-0.1.6/README.md

@@ -0,0 +1,81 @@
+# git-notes-hooks
+
+> **Automatic Git hooks to keep `refs/notes/*` seamlessly synchronized across all remotes on every push and pull.**
+
+[![PyPI Version](https://img.shields.io/pypi/v/git-notes-hooks.svg)](https://pypi.org/project/git-notes-hooks/)
+[![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue)](https://github.com/isaim0011/git-notes)
+[![Python Versions](https://img.shields.io/pypi/pyversions/git-notes-hooks.svg)](https://pypi.org/project/git-notes-hooks/)
+
+`git-notes-hooks` provides automated git lifecycle integration for the **[git-notes](https://github.com/isaim0011/git-notes)** ecosystem. It installs zero-friction client-side git hooks into your repositories to ensure decentralized code review comments and notes travel with your commits automatically.
+
+---
+
+## ⚡ Quick Installation
+
+Install from PyPI via pip:
+
+```bash
+pip install git-notes-hooks
+```
+
+Or using pipx:
+
+```bash
+pipx install git-notes-hooks
+```
+
+---
+
+## 🚀 Usage
+
+Navigate to any Git repository and run:
+
+### 1. Install Hooks
+Install the automated push/pull synchronization hooks into `.git/hooks`:
+
+```bash
+git-notes-hooks install
+```
+
+This installs:
+- `post-commit`: Updates local note indices on every commit
+- `pre-push`: Pushes `refs/notes/*` to `origin` whenever you run `git push`
+- `post-merge`: Fetches and merges remote notes from `origin` on `git pull`
+
+### 2. Check Hook Status
+Verify active git-notes hooks in your current repository:
+
+```bash
+git-notes-hooks status
+```
+
+### 3. Uninstall Hooks
+Safely remove git-notes hooks at any time:
+
+```bash
+git-notes-hooks uninstall
+```
+
+---
+
+## 🔒 History-Safe & Non-Destructive
+
+`git-notes-hooks` operates strictly on Git's native note references (`refs/notes/comments`, `refs/notes/review`, `refs/notes/todos`). It **never modifies commit SHAs, git history, or working tree files**.
+
+---
+
+## 🔗 Links & Resources
+
+- **GitHub Repository**: [https://github.com/isaim0011/git-notes](https://github.com/isaim0011/git-notes)
+- **Issue Tracker**: [https://github.com/isaim0011/git-notes/issues](https://github.com/isaim0011/git-notes/issues)
+- **Documentation**: [https://github.com/isaim0011/git-notes/blob/main/docs/ARCHITECTURE.md](https://github.com/isaim0011/git-notes/blob/main/docs/ARCHITECTURE.md)
+- **Release Downloads**: [https://github.com/isaim0011/git-notes/releases](https://github.com/isaim0011/git-notes/releases)
+
+---
+
+## 📄 License
+
+Licensed under either of:
+- Apache License, Version 2.0
+- MIT License
+at your option.

git_notes_hooks-0.1.6/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "git-notes-hooks"
+version = "0.1.6"
+description = "Automatic Git hooks to keep refs/notes/* synchronized across all remotes on push and pull"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT OR Apache-2.0" }
+authors = [
+    { name = "Bimo", email = "i.s41m0011@gmail.com" }
+]
+keywords = ["git", "git-notes", "git-hooks", "code-review", "decentralized", "developer-tools"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Version Control :: Git",
+]
+dependencies = [
+    "click>=8.1",
+    "rich>=13.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/isaim0011/git-notes"
+Repository = "https://github.com/isaim0011/git-notes"
+Issues = "https://github.com/isaim0011/git-notes/issues"
+Documentation = "https://github.com/isaim0011/git-notes#readme"
+Changelog = "https://github.com/isaim0011/git-notes/blob/main/docs/CHANGELOG.md"
+
+[project.scripts]
+git-notes-hooks = "gn_hooks.cli:main"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8",
+    "pytest-mock",
+    "ruff",
+]
+
+[tool.setuptools.packages.find]
+where = [".."]
+include = ["gn_hooks*"]
+
+[tool.pytest.ini_options]
+pythonpath = ["."]
+testpaths = ["tests"]

git_notes_hooks-0.1.6/tests/test_install.py

@@ -0,0 +1,94 @@
+from pathlib import Path
+import pytest
+
+from gn_hooks.install import find_git_root
+
+
+def test_find_git_root_at_repo_root(tmp_path: Path):
+    """find_git_root returns the path itself when .git dir is directly in path."""
+    git_dir = tmp_path / ".git"
+    git_dir.mkdir()
+
+    result = find_git_root(tmp_path)
+    assert result == tmp_path.resolve()
+
+
+def test_find_git_root_from_nested_subdir(tmp_path: Path):
+    """find_git_root walks up directory tree from a nested subdirectory to find .git dir."""
+    git_dir = tmp_path / ".git"
+    git_dir.mkdir()
+
+    nested_dir = tmp_path / "sub1" / "sub2" / "sub3"
+    nested_dir.mkdir(parents=True)
+
+    result = find_git_root(nested_dir)
+    assert result == tmp_path.resolve()
+
+
+def test_find_git_root_from_file_path(tmp_path: Path):
+    """find_git_root works when passed a file path inside a repository."""
+    git_dir = tmp_path / ".git"
+    git_dir.mkdir()
+
+    sub_dir = tmp_path / "src"
+    sub_dir.mkdir()
+    file_path = sub_dir / "main.py"
+    file_path.write_text("print('hello')")
+
+    result = find_git_root(file_path)
+    assert result == tmp_path.resolve()
+
+
+def test_find_git_root_with_relative_path(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+    """find_git_root handles relative paths correctly by resolving them."""
+    git_dir = tmp_path / ".git"
+    git_dir.mkdir()
+
+    sub_dir = tmp_path / "sub"
+    sub_dir.mkdir()
+
+    monkeypatch.chdir(sub_dir)
+    result = find_git_root(Path("."))
+    assert result == tmp_path.resolve()
+
+
+def test_find_git_root_when_git_is_a_file(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+    """find_git_root ignores .git if it is a file instead of a directory."""
+    resolved_tmp = tmp_path.resolve()
+    sub_dir = resolved_tmp / "sub"
+    sub_dir.mkdir()
+    git_file = sub_dir / ".git"
+    git_file.write_text("gitdir: /path/to/git")
+
+    # Stop search loop at resolved_tmp to isolate test from outer directory tree
+    original_parent_fget = Path.parent.fget
+
+    def custom_parent(self):
+        if self == resolved_tmp:
+            return self
+        return original_parent_fget(self)
+
+    monkeypatch.setattr(Path, "parent", property(custom_parent))
+
+    with pytest.raises(FileNotFoundError, match="Not a git repository"):
+        find_git_root(sub_dir)
+
+
+def test_find_git_root_not_found_raises_file_not_found_error(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+    """find_git_root raises FileNotFoundError when no parent directory contains a .git directory."""
+    resolved_tmp = tmp_path.resolve()
+    no_git_dir = resolved_tmp / "no_git_dir"
+    no_git_dir.mkdir()
+
+    # Stop search loop at resolved_tmp to guarantee clean test isolation
+    original_parent_fget = Path.parent.fget
+
+    def custom_parent(self):
+        if self == resolved_tmp:
+            return self
+        return original_parent_fget(self)
+
+    monkeypatch.setattr(Path, "parent", property(custom_parent))
+
+    with pytest.raises(FileNotFoundError, match="Not a git repository"):
+        find_git_root(no_git_dir)

git_notes_hooks-0.1.0/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 2.4
-Name: git-notes-hooks
-Version: 0.1.0
-Summary: Auto-install git hooks that sync refs/notes/* on push/pull
-License: MIT OR Apache-2.0
-Requires-Python: >=3.11
-Requires-Dist: click>=8.1
-Requires-Dist: rich>=13.0
-Provides-Extra: dev
-Requires-Dist: pytest>=8; extra == "dev"
-Requires-Dist: pytest-mock; extra == "dev"
-Requires-Dist: ruff; extra == "dev"

git_notes_hooks-0.1.0/pyproject.toml

@@ -1,21 +0,0 @@
-[build-system]
-requires = ["setuptools>=68", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "git-notes-hooks"
-version = "0.1.0"
-description = "Auto-install git hooks that sync refs/notes/* on push/pull"
-license = { text = "MIT OR Apache-2.0" }
-requires-python = ">=3.11"
-dependencies = ["click>=8.1", "rich>=13.0"]
-
-[project.scripts]
-git-notes-hooks = "gn_hooks.cli:main"
-
-[project.optional-dependencies]
-dev = ["pytest>=8", "pytest-mock", "ruff"]
-
-[tool.setuptools.packages.find]
-where = [".."]
-include = ["gn_hooks*"]