kosokoso 0.1.0__tar.gz

kosokoso-0.1.0/LICENSE

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

kosokoso-0.1.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: kosokoso
+Version: 0.1.0
+Summary: Create local AGENTS.md and CLAUDE.md aliases in Git repositories
+License-Expression: WTFPL
+Project-URL: Repository, https://github.com/uonr/kosokoso
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Kosokoso
+
+Kosokoso (Japanese for “stealthily”) is a small script that creates `AGENTS.md` and `CLAUDE.md` links while preventing Git from tracking them.
+
+For example, if a repository provides `CLAUDE.md` but not `AGENTS.md`, or vice versa, this script can quickly create a link for the missing file. If neither file exists, it uses `CONTRIBUTING.md` as the source for both links.
+
+## Installation
+
+Run it directly without installing anything:
+
+```console
+$ python3 kosokoso.py
+```
+
+Install it as an isolated command with uv:
+
+```console
+$ uv tool install kosokoso
+```
+
+You can also run it without installing it permanently:
+
+```console
+$ uvx kosokoso
+```
+
+With Nix:
+
+```console
+$ nix run github:uonr/kosokoso
+```
+
+## Usage
+
+Run `kosokoso` from anywhere inside a Git repository:
+
+```console
+$ kosokoso
+```
+
+If you later want Git to track the generated links, remove their rules from the repository's local exclude file:
+
+```console
+$ kosokoso --track
+```
+
+This only removes the local exclude rules; it does not run `git add`.
+
+## License
+
+[WTFPL](LICENSE)

kosokoso-0.1.0/README.md

@@ -0,0 +1,51 @@
+# Kosokoso
+
+Kosokoso (Japanese for “stealthily”) is a small script that creates `AGENTS.md` and `CLAUDE.md` links while preventing Git from tracking them.
+
+For example, if a repository provides `CLAUDE.md` but not `AGENTS.md`, or vice versa, this script can quickly create a link for the missing file. If neither file exists, it uses `CONTRIBUTING.md` as the source for both links.
+
+## Installation
+
+Run it directly without installing anything:
+
+```console
+$ python3 kosokoso.py
+```
+
+Install it as an isolated command with uv:
+
+```console
+$ uv tool install kosokoso
+```
+
+You can also run it without installing it permanently:
+
+```console
+$ uvx kosokoso
+```
+
+With Nix:
+
+```console
+$ nix run github:uonr/kosokoso
+```
+
+## Usage
+
+Run `kosokoso` from anywhere inside a Git repository:
+
+```console
+$ kosokoso
+```
+
+If you later want Git to track the generated links, remove their rules from the repository's local exclude file:
+
+```console
+$ kosokoso --track
+```
+
+This only removes the local exclude rules; it does not run `git add`.
+
+## License
+
+[WTFPL](LICENSE)

kosokoso-0.1.0/kosokoso.egg-info/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: kosokoso
+Version: 0.1.0
+Summary: Create local AGENTS.md and CLAUDE.md aliases in Git repositories
+License-Expression: WTFPL
+Project-URL: Repository, https://github.com/uonr/kosokoso
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Kosokoso
+
+Kosokoso (Japanese for “stealthily”) is a small script that creates `AGENTS.md` and `CLAUDE.md` links while preventing Git from tracking them.
+
+For example, if a repository provides `CLAUDE.md` but not `AGENTS.md`, or vice versa, this script can quickly create a link for the missing file. If neither file exists, it uses `CONTRIBUTING.md` as the source for both links.
+
+## Installation
+
+Run it directly without installing anything:
+
+```console
+$ python3 kosokoso.py
+```
+
+Install it as an isolated command with uv:
+
+```console
+$ uv tool install kosokoso
+```
+
+You can also run it without installing it permanently:
+
+```console
+$ uvx kosokoso
+```
+
+With Nix:
+
+```console
+$ nix run github:uonr/kosokoso
+```
+
+## Usage
+
+Run `kosokoso` from anywhere inside a Git repository:
+
+```console
+$ kosokoso
+```
+
+If you later want Git to track the generated links, remove their rules from the repository's local exclude file:
+
+```console
+$ kosokoso --track
+```
+
+This only removes the local exclude rules; it does not run `git add`.
+
+## License
+
+[WTFPL](LICENSE)

kosokoso-0.1.0/kosokoso.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+kosokoso.py
+pyproject.toml
+kosokoso.egg-info/PKG-INFO
+kosokoso.egg-info/SOURCES.txt
+kosokoso.egg-info/dependency_links.txt
+kosokoso.egg-info/entry_points.txt
+kosokoso.egg-info/top_level.txt

kosokoso-0.1.0/kosokoso.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

kosokoso-0.1.0/kosokoso.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+kosokoso = kosokoso:main

kosokoso-0.1.0/kosokoso.egg-info/top_level.txt

@@ -0,0 +1 @@
+kosokoso

kosokoso-0.1.0/kosokoso.py

@@ -0,0 +1,154 @@
+#!/usr/bin/env python3
+"""Create local aliases for a Git repository's agent instruction file."""
+
+from __future__ import annotations
+
+import argparse
+import os
+import subprocess
+from pathlib import Path
+
+
+def git_path(*args: str) -> Path:
+    """Return a path reported by Git, or exit with a useful error."""
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", *args],
+            check=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True,
+        )
+    except FileNotFoundError:
+        raise SystemExit("error: git is not installed or is not on PATH") from None
+    except subprocess.CalledProcessError:
+        raise SystemExit("error: the current directory is not inside a Git repository") from None
+
+    return Path(result.stdout.strip()).resolve()
+
+
+def create_link(link: Path, target: Path) -> None:
+    """Create a relative symbolic link, falling back to a hard link."""
+    relative_target = os.path.relpath(target, start=link.parent)
+    try:
+        link.symlink_to(relative_target)
+    except (NotImplementedError, OSError) as symlink_error:
+        try:
+            os.link(target, link)
+        except OSError as hardlink_error:
+            raise SystemExit(
+                f"error: could not link {link.name} to {target.name}: "
+                f"symbolic link failed ({symlink_error}); "
+                f"hard link failed ({hardlink_error})"
+            ) from None
+
+
+def tracked_paths(root: Path, paths: list[Path]) -> list[str]:
+    """Return the requested repository-relative paths found in Git's index."""
+    relative_paths = [path.relative_to(root).as_posix() for path in paths]
+    try:
+        result = subprocess.run(
+            ["git", "ls-files", "--cached", "-z", "--", *relative_paths],
+            cwd=root,
+            check=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True,
+        )
+    except subprocess.CalledProcessError as error:
+        message = error.stderr.strip() or "git ls-files failed"
+        raise SystemExit(f"error: could not inspect Git's index: {message}") from None
+
+    return sorted(path for path in result.stdout.split("\0") if path)
+
+
+def add_to_git_exclude(exclude_file: Path, names: list[str]) -> None:
+    """Add root-anchored patterns for newly created links."""
+    exclude_file.parent.mkdir(parents=True, exist_ok=True)
+
+    existing_text = exclude_file.read_text() if exclude_file.exists() else ""
+    existing_lines = set(existing_text.splitlines())
+    additions = [f"/{name}" for name in names if f"/{name}" not in existing_lines]
+    if not additions:
+        return
+
+    with exclude_file.open("a") as file:
+        if existing_text and not existing_text.endswith("\n"):
+            file.write("\n")
+        file.write("\n".join(additions) + "\n")
+
+
+def remove_from_git_exclude(exclude_file: Path, names: list[str]) -> None:
+    """Remove root-anchored patterns previously added by this script."""
+    if not exclude_file.exists():
+        return
+
+    patterns = {f"/{name}" for name in names}
+    lines = exclude_file.read_text().splitlines(keepends=True)
+    kept_lines = [line for line in lines if line.rstrip("\r\n") not in patterns]
+    if kept_lines == lines:
+        return
+
+    exclude_file.write_text("".join(kept_lines))
+    for pattern in sorted(patterns):
+        if any(line.rstrip("\r\n") == pattern for line in lines):
+            print(f"removed {pattern} from {exclude_file}")
+
+
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description="Create local aliases for a Git repository's agent instruction file."
+    )
+    parser.add_argument(
+        "--track",
+        action="store_true",
+        help="remove AGENTS.md and CLAUDE.md from the repository's local exclude file",
+    )
+    return parser.parse_args()
+
+
+def main() -> None:
+    args = parse_args()
+    root = git_path("--show-toplevel")
+    exclude_file = git_path("--git-path", "info/exclude")
+
+    if args.track:
+        remove_from_git_exclude(exclude_file, ["AGENTS.md", "CLAUDE.md"])
+        return
+
+    agents = root / "AGENTS.md"
+    claude = root / "CLAUDE.md"
+    contributing = root / "CONTRIBUTING.md"
+
+    agents_exists = os.path.lexists(agents)
+    claude_exists = os.path.lexists(claude)
+
+    if agents_exists and claude_exists:
+        return
+
+    links: list[tuple[Path, Path]]
+    if agents_exists:
+        links = [(claude, agents)]
+    elif claude_exists:
+        links = [(agents, claude)]
+    elif os.path.lexists(contributing):
+        links = [(agents, contributing), (claude, contributing)]
+    else:
+        return
+
+    tracked = tracked_paths(root, [link for link, _ in links])
+    if tracked:
+        names = ", ".join(tracked)
+        raise SystemExit(
+            f"error: refusing to create links for paths already tracked by Git: {names}\n"
+            "       .git/info/exclude cannot ignore tracked files"
+        )
+
+    for link, target in links:
+        create_link(link, target)
+        print(f"created {link.name} -> {os.readlink(link) if link.is_symlink() else target.name}")
+        add_to_git_exclude(exclude_file, [link.name])
+
+
+if __name__ == "__main__":
+    main()

kosokoso-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "kosokoso"
+version = "0.1.0"
+description = "Create local AGENTS.md and CLAUDE.md aliases in Git repositories"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "WTFPL"
+license-files = ["LICENSE"]
+dependencies = []
+classifiers = [
+  "Environment :: Console",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+]
+
+[project.scripts]
+kosokoso = "kosokoso:main"
+
+[project.urls]
+Repository = "https://github.com/uonr/kosokoso"
+
+[tool.setuptools]
+py-modules = ["kosokoso"]

kosokoso-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+