docketeer-git 0.0.6__py3-none-any.whl

docketeer_git/__init__.py

@@ -0,0 +1,7 @@
+from docketeer_git.backup import backup
+
+git_tasks = [backup]
+
+task_collections = ["docketeer_git:git_tasks"]
+
+__all__ = ["git_tasks", "task_collections"]

docketeer_git/backup.py

@@ -0,0 +1,121 @@
+"""Git-backed workspace backup — periodic commit and optional push."""
+
+import asyncio
+import logging
+import os
+from datetime import datetime, timedelta
+from pathlib import Path
+
+from docket.dependencies import Perpetual
+
+from docketeer import environment
+from docketeer.dependencies import EnvironmentStr, WorkspacePath
+
+log = logging.getLogger(__name__)
+
+BACKUP_INTERVAL = environment.get_timedelta("GIT_BACKUP_INTERVAL", timedelta(minutes=5))
+
+DEFAULT_GITIGNORE = """\
+*.lock
+*.tmp
+*.swp
+*~
+__pycache__/
+tmp/
+"""
+
+
+async def _git(
+    cwd: Path,
+    *args: str,
+    env: dict[str, str] | None = None,
+) -> asyncio.subprocess.Process:
+    """Run a git command and return the completed process."""
+    proc = await asyncio.create_subprocess_exec(
+        "git",
+        *args,
+        cwd=cwd,
+        stdout=asyncio.subprocess.PIPE,
+        stderr=asyncio.subprocess.PIPE,
+        env={**os.environ, **env} if env else None,
+    )
+    await proc.wait()
+    return proc
+
+
+async def _git_config(cwd: Path, key: str, value: str) -> None:
+    await _git(cwd, "config", key, value)
+
+
+async def _init_repo(
+    workspace: Path,
+    *,
+    branch: str,
+    remote: str,
+    author_name: str,
+    author_email: str,
+) -> None:
+    """Initialize a git repo in the workspace if one doesn't exist."""
+    await _git(workspace, "init", "-b", branch)
+    await _git_config(workspace, "user.name", author_name)
+    await _git_config(workspace, "user.email", author_email)
+
+    if remote:
+        await _git(workspace, "remote", "add", "origin", remote)
+
+    gitignore = workspace / ".gitignore"
+    if not gitignore.exists():
+        gitignore.write_text(DEFAULT_GITIGNORE)
+
+
+async def _has_changes(workspace: Path) -> bool:
+    """Check if the workspace has any uncommitted changes or untracked files."""
+    status = await _git(workspace, "status", "--porcelain")
+    assert status.stdout is not None
+    output = await status.stdout.read()
+    return bool(output.strip())
+
+
+async def backup(
+    perpetual: Perpetual = Perpetual(every=BACKUP_INTERVAL, automatic=True),
+    workspace: Path = WorkspacePath(),
+    remote: str = EnvironmentStr("GIT_REMOTE", ""),
+    branch: str = EnvironmentStr("GIT_BRANCH", "main"),
+    author_name: str = EnvironmentStr("GIT_AUTHOR_NAME", "Docketeer"),
+    author_email: str = EnvironmentStr("GIT_AUTHOR_EMAIL", "docketeer@localhost"),
+) -> None:
+    """Commit workspace changes and optionally push to a remote."""
+    if not any(workspace.iterdir()):
+        return
+
+    if not (workspace / ".git").is_dir():
+        await _init_repo(
+            workspace,
+            branch=branch,
+            remote=remote,
+            author_name=author_name,
+            author_email=author_email,
+        )
+
+    if not await _has_changes(workspace):
+        return
+
+    await _git(workspace, "add", ".")
+
+    author_env = {
+        "GIT_AUTHOR_NAME": author_name,
+        "GIT_AUTHOR_EMAIL": author_email,
+        "GIT_COMMITTER_NAME": author_name,
+        "GIT_COMMITTER_EMAIL": author_email,
+    }
+
+    timestamp = datetime.now().astimezone().strftime("%Y-%m-%d %H:%M:%S %z")
+    await _git(workspace, "commit", "-m", f"backup: {timestamp}", env=author_env)
+    log.info("Workspace backup committed: %s", timestamp)
+
+    if remote:
+        result = await _git(workspace, "push", "-u", "origin", branch)
+        if result.returncode != 0:
+            assert result.stderr is not None
+            stderr = (await result.stderr.read()).decode()
+            log.warning("Push failed: %s", stderr)

docketeer_git-0.0.6.dist-info/METADATA

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: docketeer-git
+Version: 0.0.6
+Summary: Git-backed workspace backup plugin for Docketeer
+Project-URL: Homepage, https://github.com/chrisguidry/docketeer
+Project-URL: Repository, https://github.com/chrisguidry/docketeer
+Project-URL: Issues, https://github.com/chrisguidry/docketeer/issues
+Author-email: Chris Guidry <guid@omg.lol>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: System :: Archiving :: Backup
+Requires-Python: >=3.12
+Requires-Dist: docketeer
+Requires-Dist: pydocket
+Description-Content-Type: text/markdown
+
+# docketeer-git
+
+Git-backed workspace backup plugin for
+[Docketeer](https://pypi.org/project/docketeer/). Automatically commits the
+agent's workspace (`~/.docketeer/memory/`) to a local git repo on a timer, and
+optionally pushes to a remote for off-machine backup.
+
+Install `docketeer-git` alongside `docketeer` and backups start automatically.
+No agent-facing tools are added — the agent doesn't know about backups.
+
+## Configuration
+
+| Variable | Default | Description |
+|---|---|---|
+| `DOCKETEER_GIT_BACKUP_INTERVAL` | `PT5M` | How often to check for changes (ISO 8601 duration or seconds) |
+| `DOCKETEER_GIT_REMOTE` | _(empty)_ | Remote URL to push to. No push if unset. |
+| `DOCKETEER_GIT_BRANCH` | `main` | Branch name to use |
+| `DOCKETEER_GIT_AUTHOR_NAME` | `Docketeer` | Git author name for backup commits |
+| `DOCKETEER_GIT_AUTHOR_EMAIL` | `docketeer@localhost` | Git author email for backup commits |
+
+## How it works
+
+A periodic docket task checks the workspace for uncommitted changes every 5
+minutes (configurable). If anything changed, it stages everything and commits
+with a timestamped message. If `DOCKETEER_GIT_REMOTE` is set, it pushes after
+each commit. Push failures are logged but don't crash the agent.
+
+The git repo is initialized automatically on first run. You can browse the
+history with standard git tools (`git log`, `git diff`, etc.) in the workspace
+directory.

docketeer_git-0.0.6.dist-info/RECORD

@@ -0,0 +1,6 @@
+docketeer_git/__init__.py,sha256=gB0tgUUEQcJuCOqG-_u91GieS_rsKWkeqNdHs43MBhw,155
+docketeer_git/backup.py,sha256=wv2bR0xgdiCwlgW90LLjhs-srYXbUS2W-0oswQBJuzQ,3514
+docketeer_git-0.0.6.dist-info/METADATA,sha256=rrsuqX4as8yZlBNnZoyQY97Kcl_V4v-F83DolM_Gse0,2155
+docketeer_git-0.0.6.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+docketeer_git-0.0.6.dist-info/entry_points.txt,sha256=Hwuh47wBtr58oKO6mwasZtTKy7eIzxCMJl5BEsuF3aI,55
+docketeer_git-0.0.6.dist-info/RECORD,,

docketeer_git-0.0.6.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

docketeer_git-0.0.6.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[docketeer.tasks]
+git = docketeer_git:task_collections