github-sync-agent 0.1.4__tar.gz → 0.2.1__tar.gz

{github_sync_agent-0.1.4/github_sync_agent.egg-info → github_sync_agent-0.2.1}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: github-sync-agent
-Version: 0.1.4
+Version: 0.2.1
 Summary: Sync all your local projects to GitHub automatically
-License: MIT
+Author-email: GitHub Sync Agent Maintainers <yuvalavni@users.noreply.github.com>
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/yuvalavni/Agents
 Project-URL: Repository, https://github.com/yuvalavni/Agents
-Project-URL: Bug Tracker, https://github.com/yuvalavni/Agents/issues
-Keywords: github,git,sync,backup,automation,cli
+Project-URL: Issues, https://github.com/yuvalavni/Agents/issues
+Keywords: github,git,sync,backup,automation,cli,api
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Environment :: Console
 Classifier: Topic :: Software Development :: Version Control :: Git
@@ -16,6 +16,9 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: click>=8.0
+Provides-Extra: api
+Requires-Dist: fastapi>=0.100; extra == "api"
+Requires-Dist: uvicorn>=0.23; extra == "api"
 
 # GitHub Sync Agent
 
@@ -74,6 +77,64 @@ github-sync status
 
 ---
 
+## HTTP API
+
+Install API dependencies:
+
+```bash
+pip install 'github-sync-agent[api]'
+```
+
+Start the server:
+
+```bash
+github-sync serve
+# → http://127.0.0.1:8741
+```
+
+### Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `/health` | Health check (no auth) |
+| `GET` | `/status` | Sync status for all projects |
+| `POST` | `/sync` | Sync all projects |
+| `POST` | `/sync/{project}` | Sync one project |
+
+Optional body for POST: `{"dry_run": false}`
+
+### Examples
+
+```bash
+curl http://127.0.0.1:8741/health
+curl http://127.0.0.1:8741/status
+curl -X POST http://127.0.0.1:8741/sync
+curl -X POST http://127.0.0.1:8741/sync/Agents
+```
+
+### API authentication (optional)
+
+Add to `config.yaml`:
+
+```yaml
+api_key: "your-secret-key"
+```
+
+Then pass the key on every request (except `/health`):
+
+```bash
+curl -H "Authorization: Bearer your-secret-key" http://127.0.0.1:8741/status
+```
+
+### Run as a systemd service
+
+```bash
+cp systemd/github-sync-api.service ~/.config/systemd/user/
+systemctl --user enable --now github-sync-api.service
+```
+
+---
+
 ## Configuration (`~/.config/github-sync/config.yaml`)
 
 Generated by `github-sync init`. You can edit it at any time.
@@ -88,6 +149,9 @@ Generated by `github-sync init`. You can edit it at any time.
 | `exclude` | `[]` | Directory names to skip |
 | `log_file` | `~/.local/share/github-sync/github-sync.log` | Log file path |
 | `log_level` | `INFO` | `DEBUG` / `INFO` / `WARNING` / `ERROR` |
+| `api_host` | `127.0.0.1` | API bind address |
+| `api_port` | `8741` | API port |
+| `api_key` | _(empty)_ | Optional Bearer token for API auth |
 
 ### Excluding a project
 

github_sync_agent-0.1.4/PKG-INFO → github_sync_agent-0.2.1/README.md

@@ -1,22 +1,3 @@
-Metadata-Version: 2.4
-Name: github-sync-agent
-Version: 0.1.4
-Summary: Sync all your local projects to GitHub automatically
-License: MIT
-Project-URL: Homepage, https://github.com/yuvalavni/Agents
-Project-URL: Repository, https://github.com/yuvalavni/Agents
-Project-URL: Bug Tracker, https://github.com/yuvalavni/Agents/issues
-Keywords: github,git,sync,backup,automation,cli
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Environment :: Console
-Classifier: Topic :: Software Development :: Version Control :: Git
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: click>=8.0
-
 # GitHub Sync Agent
 
 Automatically syncs every local project directory to its own GitHub repository.
@@ -74,6 +55,64 @@ github-sync status
 
 ---
 
+## HTTP API
+
+Install API dependencies:
+
+```bash
+pip install 'github-sync-agent[api]'
+```
+
+Start the server:
+
+```bash
+github-sync serve
+# → http://127.0.0.1:8741
+```
+
+### Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `/health` | Health check (no auth) |
+| `GET` | `/status` | Sync status for all projects |
+| `POST` | `/sync` | Sync all projects |
+| `POST` | `/sync/{project}` | Sync one project |
+
+Optional body for POST: `{"dry_run": false}`
+
+### Examples
+
+```bash
+curl http://127.0.0.1:8741/health
+curl http://127.0.0.1:8741/status
+curl -X POST http://127.0.0.1:8741/sync
+curl -X POST http://127.0.0.1:8741/sync/Agents
+```
+
+### API authentication (optional)
+
+Add to `config.yaml`:
+
+```yaml
+api_key: "your-secret-key"
+```
+
+Then pass the key on every request (except `/health`):
+
+```bash
+curl -H "Authorization: Bearer your-secret-key" http://127.0.0.1:8741/status
+```
+
+### Run as a systemd service
+
+```bash
+cp systemd/github-sync-api.service ~/.config/systemd/user/
+systemctl --user enable --now github-sync-api.service
+```
+
+---
+
 ## Configuration (`~/.config/github-sync/config.yaml`)
 
 Generated by `github-sync init`. You can edit it at any time.
@@ -88,6 +127,9 @@ Generated by `github-sync init`. You can edit it at any time.
 | `exclude` | `[]` | Directory names to skip |
 | `log_file` | `~/.local/share/github-sync/github-sync.log` | Log file path |
 | `log_level` | `INFO` | `DEBUG` / `INFO` / `WARNING` / `ERROR` |
+| `api_host` | `127.0.0.1` | API bind address |
+| `api_port` | `8741` | API port |
+| `api_key` | _(empty)_ | Optional Bearer token for API auth |
 
 ### Excluding a project
 

github_sync_agent-0.2.1/github_sync/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.1"

github_sync_agent-0.2.1/github_sync/api.py

@@ -0,0 +1,111 @@
+"""HTTP API for the GitHub Sync Agent."""
+
+from __future__ import annotations
+
+import asyncio
+import logging
+
+from fastapi import Depends, FastAPI, HTTPException, Security
+from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
+from pydantic import BaseModel, Field
+
+from . import __version__
+from . import agent
+
+LOG = logging.getLogger(__name__)
+_security = HTTPBearer(auto_error=False)
+
+
+class SyncRequest(BaseModel):
+    dry_run: bool = False
+
+
+class SyncResult(BaseModel):
+    project: str
+    success: bool
+
+
+class SyncResponse(BaseModel):
+    success: bool
+    synced: int
+    failed: int
+    results: list[SyncResult]
+
+
+class StatusRow(BaseModel):
+    project: str
+    root: str
+    git: bool
+    remote: bool
+    changes: bool
+    on_github: bool
+
+
+class StatusResponse(BaseModel):
+    github_user: str
+    projects_root: list[str]
+    projects: list[StatusRow]
+
+
+def create_app(cfg: dict) -> FastAPI:
+    api_key: str = cfg.get("api_key") or ""
+
+    app = FastAPI(
+        title="GitHub Sync Agent API",
+        description="Trigger and inspect GitHub sync operations over HTTP.",
+        version=__version__,
+    )
+
+    async def require_auth(
+        credentials: HTTPAuthorizationCredentials | None = Security(_security),
+    ) -> None:
+        if not api_key:
+            return
+        if credentials is None or credentials.credentials != api_key:
+            raise HTTPException(status_code=401, detail="Invalid or missing API key")
+
+    @app.get("/health")
+    async def health() -> dict[str, str]:
+        return {"status": "ok", "version": __version__}
+
+    @app.get("/status", response_model=StatusResponse, dependencies=[Depends(require_auth)])
+    async def status() -> StatusResponse:
+        rows = await asyncio.to_thread(agent.get_status, cfg)
+        return StatusResponse(
+            github_user=cfg["github_user"],
+            projects_root=cfg["projects_root"],
+            projects=[StatusRow(**row) for row in rows],
+        )
+
+    @app.post("/sync", response_model=SyncResponse, dependencies=[Depends(require_auth)])
+    async def sync_all(body: SyncRequest = SyncRequest()) -> SyncResponse:
+        return await _run_sync(cfg, project=None, dry_run=body.dry_run)
+
+    @app.post("/sync/{project}", response_model=SyncResponse, dependencies=[Depends(require_auth)])
+    async def sync_one(project: str, body: SyncRequest = SyncRequest()) -> SyncResponse:
+        return await _run_sync(cfg, project=project, dry_run=body.dry_run)
+
+    return app
+
+
+async def _run_sync(cfg: dict, project: str | None, dry_run: bool) -> SyncResponse:
+    try:
+        projects = await asyncio.to_thread(agent.discover_projects, cfg, project)
+    except ValueError as exc:
+        raise HTTPException(status_code=404, detail=str(exc)) from exc
+
+    results: list[SyncResult] = []
+    for path in projects:
+        ok = await asyncio.to_thread(agent.sync_project, path, cfg, dry_run)
+        results.append(SyncResult(project=path.name, success=ok))
+        level = logging.INFO if ok else logging.ERROR
+        LOG.log(level, "%s %s", path.name, "synced" if ok else "FAILED")
+
+    synced = sum(1 for r in results if r.success)
+    failed = len(results) - synced
+    return SyncResponse(
+        success=failed == 0,
+        synced=synced,
+        failed=failed,
+        results=results,
+    )

{github_sync_agent-0.1.4 → github_sync_agent-0.2.1}/github_sync/cli.py

@@ -253,9 +253,44 @@ def init() -> None:
     click.echo(f"  github-sync status          # see all your projects")
     click.echo(f"  github-sync sync --dry-run  # preview what will be synced")
     click.echo(f"  github-sync sync            # sync everything to GitHub")
+    click.echo(f"  github-sync serve           # start HTTP API (requires [api] extra)")
     click.echo()
 
 
+# ---------------------------------------------------------------------------
+# serve
+# ---------------------------------------------------------------------------
+
+@cli.command()
+@click.option("--host", default=None, help="Bind address (default: api_host from config)")
+@click.option("--port", default=None, type=int, help="Port (default: api_port from config)")
+@click.pass_context
+def serve(ctx: click.Context, host: str | None, port: int | None) -> None:
+    """Start the HTTP API server."""
+    try:
+        import uvicorn
+    except ImportError:
+        click.echo("Error: API dependencies not installed.", err=True)
+        click.echo("Run: pip install 'github-sync-agent[api]'", err=True)
+        sys.exit(1)
+
+    cfg = ctx.obj["cfg"]
+    _setup_logging(cfg)
+
+    from .api import create_app
+
+    bind_host = host or cfg.get("api_host", "127.0.0.1")
+    bind_port = port or int(cfg.get("api_port", 8741))
+    app = create_app(cfg)
+
+    auth_note = "API key required" if cfg.get("api_key") else "no auth (localhost only recommended)"
+    click.echo(f"Starting GitHub Sync API on http://{bind_host}:{bind_port} ({auth_note})")
+    click.echo("Endpoints: GET /health  GET /status  POST /sync  POST /sync/{project}")
+    click.echo()
+
+    uvicorn.run(app, host=bind_host, port=bind_port, log_level=cfg.get("log_level", "info").lower())
+
+
 # ---------------------------------------------------------------------------
 # Entry point
 # ---------------------------------------------------------------------------

{github_sync_agent-0.1.4 → github_sync_agent-0.2.1}/github_sync/config.py

@@ -26,6 +26,9 @@ def _apply_defaults(cfg: dict) -> None:
     cfg.setdefault("exclude", [])
     cfg.setdefault("log_file", str(Path.home() / ".local" / "share" / "github-sync" / "github-sync.log"))
     cfg.setdefault("log_level", "INFO")
+    cfg.setdefault("api_host", "127.0.0.1")
+    cfg.setdefault("api_port", 8741)
+    cfg.setdefault("api_key", "")
 
     if not cfg.get("github_user"):
         raise ValueError("Missing required config key: 'github_user'")

{github_sync_agent-0.1.4 → github_sync_agent-0.2.1}/github_sync/setup.py

@@ -276,6 +276,11 @@ exclude: []
 # Logging
 log_file: {log_file}
 log_level: INFO
+
+# HTTP API (github-sync serve)
+api_host: "127.0.0.1"
+api_port: 8741
+# api_key: "change-me"   # uncomment to require: Authorization: Bearer <key>
 """
 
 

github_sync_agent-0.2.1/github_sync_agent.egg-info/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: github-sync-agent
+Version: 0.2.1
+Summary: Sync all your local projects to GitHub automatically
+Author-email: GitHub Sync Agent Maintainers <yuvalavni@users.noreply.github.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/yuvalavni/Agents
+Project-URL: Repository, https://github.com/yuvalavni/Agents
+Project-URL: Issues, https://github.com/yuvalavni/Agents/issues
+Keywords: github,git,sync,backup,automation,cli,api
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Environment :: Console
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: click>=8.0
+Provides-Extra: api
+Requires-Dist: fastapi>=0.100; extra == "api"
+Requires-Dist: uvicorn>=0.23; extra == "api"
+
+# GitHub Sync Agent
+
+Automatically syncs every local project directory to its own GitHub repository.
+
+For each project it will:
+1. `git init` if not already a repo
+2. Create the GitHub repo if it doesn't exist yet
+3. Ensure the remote uses SSH
+4. Stage + commit any uncommitted changes
+5. Push to `origin`
+
+Runs daily via a systemd user timer, and on-demand via CLI.
+
+---
+
+## Installation
+
+```bash
+pip install github-sync-agent
+```
+
+## First-time setup
+
+```bash
+github-sync init
+```
+
+The wizard will:
+- Check `git` and `gh` are installed
+- Authenticate with GitHub (`gh auth login`)
+- Ask which folder to scan for projects
+- Set up your SSH key automatically
+- **Verify SSH works** (auto-fixes port 443 and ssh-agent if needed)
+- Write a config file to `~/.config/github-sync/config.yaml`
+
+Setup will **not** complete until `ssh -T git@github.com` succeeds.
+
+---
+
+## Usage
+
+```bash
+# Sync all projects
+github-sync sync
+
+# Sync a single project
+github-sync sync --project my-project
+
+# Preview without making changes
+github-sync sync --dry-run
+
+# Show status of all projects
+github-sync status
+```
+
+---
+
+## HTTP API
+
+Install API dependencies:
+
+```bash
+pip install 'github-sync-agent[api]'
+```
+
+Start the server:
+
+```bash
+github-sync serve
+# → http://127.0.0.1:8741
+```
+
+### Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `/health` | Health check (no auth) |
+| `GET` | `/status` | Sync status for all projects |
+| `POST` | `/sync` | Sync all projects |
+| `POST` | `/sync/{project}` | Sync one project |
+
+Optional body for POST: `{"dry_run": false}`
+
+### Examples
+
+```bash
+curl http://127.0.0.1:8741/health
+curl http://127.0.0.1:8741/status
+curl -X POST http://127.0.0.1:8741/sync
+curl -X POST http://127.0.0.1:8741/sync/Agents
+```
+
+### API authentication (optional)
+
+Add to `config.yaml`:
+
+```yaml
+api_key: "your-secret-key"
+```
+
+Then pass the key on every request (except `/health`):
+
+```bash
+curl -H "Authorization: Bearer your-secret-key" http://127.0.0.1:8741/status
+```
+
+### Run as a systemd service
+
+```bash
+cp systemd/github-sync-api.service ~/.config/systemd/user/
+systemctl --user enable --now github-sync-api.service
+```
+
+---
+
+## Configuration (`~/.config/github-sync/config.yaml`)
+
+Generated by `github-sync init`. You can edit it at any time.
+
+| Key | Default | Description |
+|-----|---------|-------------|
+| `github_user` | _(detected from gh auth)_ | Your GitHub username |
+| `projects_root` | `~/projects` | Scans all subdirectories here |
+| `schedule_time` | `02:00` | Daily run time |
+| `default_visibility` | `private` | `private` or `public` for new repos |
+| `auto_commit_message` | `chore: auto-sync` | Commit message for auto-commits |
+| `exclude` | `[]` | Directory names to skip |
+| `log_file` | `~/.local/share/github-sync/github-sync.log` | Log file path |
+| `log_level` | `INFO` | `DEBUG` / `INFO` / `WARNING` / `ERROR` |
+| `api_host` | `127.0.0.1` | API bind address |
+| `api_port` | `8741` | API port |
+| `api_key` | _(empty)_ | Optional Bearer token for API auth |
+
+### Excluding a project
+
+```yaml
+exclude:
+  - SomeProjectToSkip
+```
+
+---
+
+## Requirements
+
+- Python 3.10+
+- `git` installed
+- `gh` (GitHub CLI) installed — [installation guide](https://cli.github.com)
+
+---
+
+## License
+
+MIT

{github_sync_agent-0.1.4 → github_sync_agent-0.2.1}/github_sync_agent.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ README.md
 pyproject.toml
 github_sync/__init__.py
 github_sync/agent.py
+github_sync/api.py
 github_sync/cli.py
 github_sync/config.py
 github_sync/setup.py

github_sync_agent-0.2.1/github_sync_agent.egg-info/requires.txt

@@ -0,0 +1,6 @@
+pyyaml>=6.0
+click>=8.0
+
+[api]
+fastapi>=0.100
+uvicorn>=0.23

{github_sync_agent-0.1.4 → github_sync_agent-0.2.1}/pyproject.toml

@@ -4,16 +4,17 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "github-sync-agent"
-version = "0.1.4"
+version = "0.2.1"
 description = "Sync all your local projects to GitHub automatically"
 readme = "README.md"
 requires-python = ">=3.10"
-license = { text = "MIT" }
-authors = []
-keywords = ["github", "git", "sync", "backup", "automation", "cli"]
+license = "MIT"
+authors = [
+    { name = "GitHub Sync Agent Maintainers", email = "yuvalavni@users.noreply.github.com" },
+]
+keywords = ["github", "git", "sync", "backup", "automation", "cli", "api"]
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: POSIX :: Linux",
     "Environment :: Console",
     "Topic :: Software Development :: Version Control :: Git",
@@ -23,10 +24,16 @@ dependencies = [
     "click>=8.0",
 ]
 
+[project.optional-dependencies]
+api = [
+    "fastapi>=0.100",
+    "uvicorn>=0.23",
+]
+
 [project.urls]
 Homepage = "https://github.com/yuvalavni/Agents"
 Repository = "https://github.com/yuvalavni/Agents"
-"Bug Tracker" = "https://github.com/yuvalavni/Agents/issues"
+Issues = "https://github.com/yuvalavni/Agents/issues"
 
 [project.scripts]
 github-sync = "github_sync.cli:main"

github_sync_agent-0.1.4/README.md

@@ -1,92 +0,0 @@
-# GitHub Sync Agent
-
-Automatically syncs every local project directory to its own GitHub repository.
-
-For each project it will:
-1. `git init` if not already a repo
-2. Create the GitHub repo if it doesn't exist yet
-3. Ensure the remote uses SSH
-4. Stage + commit any uncommitted changes
-5. Push to `origin`
-
-Runs daily via a systemd user timer, and on-demand via CLI.
-
----
-
-## Installation
-
-```bash
-pip install github-sync-agent
-```
-
-## First-time setup
-
-```bash
-github-sync init
-```
-
-The wizard will:
-- Check `git` and `gh` are installed
-- Authenticate with GitHub (`gh auth login`)
-- Ask which folder to scan for projects
-- Set up your SSH key automatically
-- **Verify SSH works** (auto-fixes port 443 and ssh-agent if needed)
-- Write a config file to `~/.config/github-sync/config.yaml`
-
-Setup will **not** complete until `ssh -T git@github.com` succeeds.
-
----
-
-## Usage
-
-```bash
-# Sync all projects
-github-sync sync
-
-# Sync a single project
-github-sync sync --project my-project
-
-# Preview without making changes
-github-sync sync --dry-run
-
-# Show status of all projects
-github-sync status
-```
-
----
-
-## Configuration (`~/.config/github-sync/config.yaml`)
-
-Generated by `github-sync init`. You can edit it at any time.
-
-| Key | Default | Description |
-|-----|---------|-------------|
-| `github_user` | _(detected from gh auth)_ | Your GitHub username |
-| `projects_root` | `~/projects` | Scans all subdirectories here |
-| `schedule_time` | `02:00` | Daily run time |
-| `default_visibility` | `private` | `private` or `public` for new repos |
-| `auto_commit_message` | `chore: auto-sync` | Commit message for auto-commits |
-| `exclude` | `[]` | Directory names to skip |
-| `log_file` | `~/.local/share/github-sync/github-sync.log` | Log file path |
-| `log_level` | `INFO` | `DEBUG` / `INFO` / `WARNING` / `ERROR` |
-
-### Excluding a project
-
-```yaml
-exclude:
-  - SomeProjectToSkip
-```
-
----
-
-## Requirements
-
-- Python 3.10+
-- `git` installed
-- `gh` (GitHub CLI) installed — [installation guide](https://cli.github.com)
-
----
-
-## License
-
-MIT

github_sync_agent-0.1.4/github_sync/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.4"

github_sync_agent-0.1.4/github_sync_agent.egg-info/requires.txt

@@ -1,2 +0,0 @@
-pyyaml>=6.0
-click>=8.0