navig-github 0.2.0__tar.gz → 0.2.4__tar.gz

{navig_github-0.2.0 → navig_github-0.2.4}/PKG-INFO

@@ -1,11 +1,25 @@
 Metadata-Version: 2.4
 Name: navig-github
-Version: 0.2.0
+Version: 0.2.4
 Summary: NAVIG GitHub module — the full GitHub toolbox (backup, mirror, export, manage) wired into `navig github`. A first-party navig plugin (free, toggleable).
+Author-email: NAVIG Development Team <opensource@navig.run>
 License-Expression: Apache-2.0
+Project-URL: Homepage, https://navig.run
+Project-URL: Documentation, https://navig.run/docs
+Keywords: navig,cli,agent,automation,plugin,github,git,backup,mirror
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: navig>=3.24.0
 Requires-Dist: requests>=2.31.0
 Requires-Dist: python-dotenv>=1.0.0
 Requires-Dist: schedule>=1.2.0

{navig_github-0.2.0 → navig_github-0.2.4}/navig_github/commands/github.py

@@ -185,12 +185,12 @@ def _fallback_git_clone(repo_url: str, dest: str) -> None:
         result = subprocess.run(
             ["git", "-C", str(clone_dest), "pull", "--ff-only"],
             capture_output=True,
-            text=True,
+            text=True, encoding="utf-8", errors="replace",
         )
     else:
         ch.info(f"Cloning {repo_url} → {clone_dest} …")
         result = subprocess.run(
-            ["git", "clone", repo_url, str(clone_dest)], capture_output=True, text=True
+            ["git", "clone", repo_url, str(clone_dest)], capture_output=True, text=True, encoding="utf-8", errors="replace"
         )
 
     if result.returncode == 0:
@@ -339,10 +339,10 @@ def gh_clone(
     token: Annotated[str | None, typer.Option("--token", "-t", help="GitHub token")] = None,
 ):
     """
-    ⬇️  Clone a single repository (with the engine if available, else plain git).
+    ⬇️  Clone a single repository (with the full toolbox if available, else plain git).
 
     Always FLAT — lands directly as <dest>/<repo> (like `git clone`). Falls back
-    to a plain `git clone` when no token is configured and the engine is unavailable.
+    to a plain `git clone` when no token is configured and the full toolbox is unavailable.
 
     Examples:
         navig github clone owner/my-repo -d ./mirrors
@@ -390,7 +390,7 @@ def token_set(
     ] = True,
 ):
     """
-    🔑 Save a GitHub token for the engine to use automatically.
+    🔑 Save a GitHub token for navig github to use automatically.
 
     Stores in the navig vault by default (preferred). Falls back to
     writing to ~/.navig/config.yaml when the vault is unavailable.
@@ -465,7 +465,7 @@ def token_show():
         ch.warning(
             "No GitHub token configured.\n"
             "Set one with:  navig github token set <your-token>\n"
-            "Without a token, the engine only accesses public repos at low rate limits."
+            "Without a token, navig github only accesses public repos at low rate limits."
         )
 
 
@@ -520,6 +520,7 @@ def gh_status():
         navig github status
     """
     # engine availability (bundled engine — a hard dependency of navig-github)
+    engine_missing = False
     if _engine_available():
         try:
             import navig_github.engine as fm  # type: ignore
@@ -531,6 +532,7 @@ def gh_status():
     else:
         ch.error("GitHub engine MISSING (it is a dependency of navig-github).")
         ch.info("Reinstall the plugin:  pip install navig-github")
+        engine_missing = True
         
     # Token check
     token = _resolve_github_token()
@@ -543,6 +545,13 @@ def gh_status():
             "Set one with:  navig github token set <your-token>"
         )
 
+    if engine_missing:
+        # The engine is a hard dependency, so this is a BROKEN install, not a
+        # state the operator can be in on purpose. Raised at the end so the token
+        # check above still prints — a status command should show everything it
+        # knows before it exits.
+        raise typer.Exit(1)
+
 
 # ---------------------------------------------------------------------------
 # Full engine mount — every engine command becomes `navig github <command>`

{navig_github-0.2.0 → navig_github-0.2.4}/navig_github/engine/analytics.py

@@ -12,6 +12,8 @@ from datetime import datetime
 from pathlib import Path
 from typing import Any
 
+from navig.core.json_io import JsonReadError, atomic_write_json, load_json_for_update
+
 
 @dataclass
 class RepositoryStats:
@@ -151,22 +153,42 @@ class BackupAnalytics:
         """Initialize the analytics engine."""
         self.backup_dir = backup_dir or Path("backups")
         self._history: list[BackupHistory] = []
+        # True when history.json existed but was transiently UNREADABLE at load (a Windows
+        # AV/backup lock, or a truncated write). While set, _save_history REFUSES to write —
+        # _history is empty by accident, not because there are no backups, and overwriting it
+        # would wipe the recorded history. A per-run engine re-reads on the next construction.
+        self._history_load_failed = False
         self._load_history()
     
     def _load_history(self) -> None:
         """Load backup history from disk."""
         history_path = self.backup_dir / self.HISTORY_FILE
-        if history_path.exists():
-            try:
-                data = json.loads(history_path.read_text())
-                self._history = [
-                    BackupHistory(**h) for h in data.get("history", [])
-                ]
-            except (json.JSONDecodeError, TypeError):
-                self._history = []
-    
+        if not history_path.exists():
+            self._history_load_failed = False
+            return
+        try:
+            # load_json_for_update RAISES on a transiently-unreadable-but-populated file (a
+            # lock — the old narrow except missed PermissionError and crashed construction) and
+            # quarantines a corrupt/truncated one to *.corrupt instead of reading it as empty.
+            data = load_json_for_update(history_path, default={"history": []})
+        except JsonReadError:
+            self._history_load_failed = True
+            self._history = []
+            return
+        self._history_load_failed = False
+        try:
+            self._history = [
+                BackupHistory(**h) for h in data.get("history", [])
+            ]
+        except (TypeError, KeyError):
+            self._history = []
+
     def _save_history(self) -> None:
         """Save backup history to disk."""
+        if self._history_load_failed:
+            # History was unreadable at load, so _history is empty by accident — writing it
+            # would wipe the recorded backups. Refuse until a clean load.
+            return
         history_path = self.backup_dir / self.HISTORY_FILE
         history_path.parent.mkdir(parents=True, exist_ok=True)
         data = {
@@ -174,7 +196,7 @@ class BackupAnalytics:
             "updated_at": datetime.now().isoformat(),
             "history": [h.to_dict() for h in self._history],
         }
-        history_path.write_text(json.dumps(data, indent=2))
+        atomic_write_json(data, history_path)
     
     def record_backup(
         self,
@@ -247,7 +269,7 @@ class BackupAnalytics:
                 cwd=repo_path,
                 capture_output=True,
                 text=True,
-                timeout=30,
+                timeout=30, encoding="utf-8", errors="replace",
             )
             if result.returncode == 0:
                 stats.commit_count = int(result.stdout.strip())
@@ -261,7 +283,7 @@ class BackupAnalytics:
                 cwd=repo_path,
                 capture_output=True,
                 text=True,
-                timeout=30,
+                timeout=30, encoding="utf-8", errors="replace",
             )
             if result.returncode == 0:
                 stats.branch_count = len([
@@ -278,7 +300,7 @@ class BackupAnalytics:
                 cwd=repo_path,
                 capture_output=True,
                 text=True,
-                timeout=30,
+                timeout=30, encoding="utf-8", errors="replace",
             )
             if result.returncode == 0:
                 stats.tag_count = len([t for t in result.stdout.strip().split("\n") if t.strip()])
@@ -292,7 +314,7 @@ class BackupAnalytics:
                 cwd=repo_path,
                 capture_output=True,
                 text=True,
-                timeout=30,
+                timeout=30, encoding="utf-8", errors="replace",
             )
             if result.returncode == 0 and result.stdout.strip():
                 stats.last_commit_date = result.stdout.strip()
@@ -304,7 +326,7 @@ class BackupAnalytics:
         if lfs_config.exists() or (repo_path / ".gitattributes").exists():
             gitattributes = repo_path / ".gitattributes"
             if gitattributes.exists():
-                content = gitattributes.read_text()
+                content = gitattributes.read_text(encoding="utf-8")
                 stats.has_lfs = "filter=lfs" in content
         
         # Get language statistics (for non-bare repos)

{navig_github-0.2.0 → navig_github-0.2.4}/navig_github/engine/cli.py

@@ -251,7 +251,7 @@ def export_repository_data(
                         for issue in issues_list
                     ],
                 }
-                with open(dest, "w") as f:
+                with open(dest, "w", encoding="utf-8") as f:
                     json.dump(issues_data, f, indent=2)
                 console.print(f"   [green]✓ Issues exported: {owner}/{repo_name} ({len(issues_list)} issues)[/green]")
 
@@ -278,7 +278,7 @@ def export_repository_data(
                         for pr in prs_list
                     ],
                 }
-                with open(dest, "w") as f:
+                with open(dest, "w", encoding="utf-8") as f:
                     json.dump(prs_data, f, indent=2)
                 console.print(f"   [green]✓ Pull requests exported: {owner}/{repo_name} ({len(prs_list)} PRs)[/green]")
 
@@ -291,7 +291,7 @@ def export_repository_data(
                 if workflows_list:
                     for wf_file in workflow_files:
                         file_path = dest / Path(wf_file["path"]).name
-                        with open(file_path, "w") as f:
+                        with open(file_path, "w", encoding="utf-8") as f:
                             f.write(wf_file["content"])
 
                     metadata = {
@@ -300,7 +300,7 @@ def export_repository_data(
                         "exported_at": datetime.now().isoformat(),
                         "workflows": [{"name": wf.name, "path": wf.path} for wf in workflows_list],
                     }
-                    with open(dest / "metadata.json", "w") as f:
+                    with open(dest / "metadata.json", "w", encoding="utf-8") as f:
                         json.dump(metadata, f, indent=2)
                     console.print(f"   [green]✓ Workflows exported: {owner}/{repo_name} ({len(workflows_list)} workflows)[/green]")
 
@@ -325,7 +325,7 @@ def export_repository_data(
                             for release in releases_list
                         ],
                     }
-                    with open(dest / "metadata.json", "w") as f:
+                    with open(dest / "metadata.json", "w", encoding="utf-8") as f:
                         json.dump(metadata, f, indent=2)
                     console.print(f"   [green]✓ Releases exported: {owner}/{repo_name} ({len(releases_list)} releases)[/green]")
 
@@ -345,7 +345,7 @@ def export_repository_data(
                                 capture_output=True,
                                 text=True,
                                 check=True,
-                                timeout=300,
+                                timeout=300, encoding="utf-8", errors="replace",
                             )
                             console.print(f"   [green]✓ Wiki cloned: {owner}/{repo_name}[/green]")
                         except subprocess.CalledProcessError:
@@ -358,7 +358,7 @@ def export_repository_data(
                                 capture_output=True,
                                 text=True,
                                 check=True,
-                                timeout=120,
+                                timeout=120, encoding="utf-8", errors="replace",
                             )
                             console.print(f"   [green]✓ Wiki updated: {owner}/{repo_name}[/green]")
                         except subprocess.CalledProcessError:
@@ -1184,7 +1184,7 @@ def secrets(
     ⚠️  Note: GitHub API does NOT expose secret values, only names and metadata.
 
     Example:
-        navig github secrets miztizm/the engine
+        navig github secrets miztizm/navig-github
         navig github secrets miztizm/hello-world --format yaml
         navig github secrets miztizm/navig github --dest ./custom_secrets.json
     """
@@ -1546,7 +1546,7 @@ def clone(
     drops the repo right where you are, defaults to HTTPS (no SSH keys needed
     for public repos), and needs no token or GitHub API call for public repos.
 
-    "Sometimes you just want the code, not the whole archive." — the engine
+    "Sometimes you just want the code, not the whole archive." — navig github
 
     Example:
         navig github clone microsoft/vscode
@@ -1707,10 +1707,10 @@ def issues(
 
         # Export to file
         if format == "yaml":
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 yaml.dump(issues_data, f, default_flow_style=False, sort_keys=False)
         else:
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 json.dump(issues_data, f, indent=2)
 
         # Create summary table
@@ -1840,10 +1840,10 @@ def pulls(
 
         # Export to file
         if format == "yaml":
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 yaml.dump(prs_data, f, default_flow_style=False, sort_keys=False)
         else:
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 json.dump(prs_data, f, indent=2)
 
         # Create summary table
@@ -1930,7 +1930,7 @@ def workflows(
         # Save workflow files
         for wf_file in workflow_files:
             file_path = dest / Path(wf_file["path"]).name
-            with open(file_path, "w") as f:
+            with open(file_path, "w", encoding="utf-8") as f:
                 f.write(wf_file["content"])
 
         # Save metadata
@@ -1971,7 +1971,7 @@ def workflows(
 
         # Save metadata
         metadata_path = dest / "metadata.json"
-        with open(metadata_path, "w") as f:
+        with open(metadata_path, "w", encoding="utf-8") as f:
             json.dump(metadata, f, indent=2)
 
         console.print(f"\n[green]✅ Workflows backed up to: {dest}[/green]")
@@ -2070,7 +2070,7 @@ def releases(
         }
 
         metadata_path = dest / "metadata.json"
-        with open(metadata_path, "w") as f:
+        with open(metadata_path, "w", encoding="utf-8") as f:
             json.dump(metadata, f, indent=2)
 
         # Download assets if requested
@@ -2095,7 +2095,7 @@ def releases(
                     "author": release.author,
                     "html_url": release.html_url,
                 }
-                with open(release_dir / "release.json", "w") as f:
+                with open(release_dir / "release.json", "w", encoding="utf-8") as f:
                     json.dump(release_metadata, f, indent=2)
 
                 # Download each asset
@@ -2196,7 +2196,7 @@ def wiki(
                     capture_output=True,
                     text=True,
                     check=True,
-                    timeout=120,
+                    timeout=120, encoding="utf-8", errors="replace",
                 )
                 console.print(f"[green]✅ Wiki updated: {dest}[/green]")
             except subprocess.CalledProcessError as e:
@@ -2210,7 +2210,7 @@ def wiki(
                     capture_output=True,
                     text=True,
                     check=True,
-                    timeout=300,
+                    timeout=300, encoding="utf-8", errors="replace",
                 )
                 console.print(f"[green]✅ Wiki cloned to: {dest}[/green]")
             except subprocess.CalledProcessError as e:
@@ -2593,7 +2593,7 @@ def attachments(
     issues and pull requests, including images, documents, and other attachments.
 
     Example:
-        navig github attachments miztizm/the engine
+        navig github attachments miztizm/navig-github
         navig github attachments myorg/myrepo --source issues
         navig github attachments myorg/myrepo --source pulls --dest ./my-attachments
     """
@@ -2739,7 +2739,7 @@ def labels(
 
 
     Example:
-        navig github labels miztizm/the engine
+        navig github labels miztizm/navig-github
         navig github labels myorg/myrepo --format yaml
         navig github labels myorg/myrepo --dest ./my-labels.json
     """
@@ -2791,10 +2791,10 @@ def labels(
 
         # Export to file
         if format.lower() == "yaml":
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 yaml.dump(labels_data, f, default_flow_style=False, sort_keys=False)
         else:
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 json.dump(labels_data, f, indent=2)
 
         # Create summary table
@@ -2857,7 +2857,7 @@ def milestones(
 
 
     Example:
-        navig github milestones miztizm/the engine
+        navig github milestones miztizm/navig-github
         navig github milestones myorg/myrepo --state open
         navig github milestones myorg/myrepo --format yaml
     """
@@ -2918,10 +2918,10 @@ def milestones(
 
         # Export to file
         if format.lower() == "yaml":
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 yaml.dump(milestones_data, f, default_flow_style=False, sort_keys=False)
         else:
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 json.dump(milestones_data, f, indent=2)
 
         # Create summary table
@@ -2987,7 +2987,7 @@ def webhooks(
     ⚠️  Note: Requires admin access to the repository. Secret values are redacted.
 
     Example:
-        navig github webhooks miztizm/the engine
+        navig github webhooks miztizm/navig-github
         navig github webhooks myorg/myrepo --format yaml
     """
     if format.lower() not in ["json", "yaml"]:
@@ -3042,10 +3042,10 @@ def webhooks(
 
         # Export to file
         if format.lower() == "yaml":
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 yaml.dump(webhooks_data, f, default_flow_style=False, sort_keys=False)
         else:
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 json.dump(webhooks_data, f, indent=2)
 
         # Create summary table
@@ -3188,10 +3188,10 @@ def followers(
 
         # Export to file
         if format.lower() == "yaml":
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 yaml.dump(export_data, f, default_flow_style=False, sort_keys=False)
         else:
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 json.dump(export_data, f, indent=2)
 
         # Create summary table
@@ -3244,7 +3244,7 @@ def discussions(
     Uses the GitHub GraphQL API to fetch discussions data.
 
     Example:
-        navig github discussions miztizm/the engine
+        navig github discussions miztizm/navig-github
         navig github discussions myorg/myrepo --format yaml
     """
     if format.lower() not in ["json", "yaml"]:
@@ -3304,10 +3304,10 @@ def discussions(
 
         # Export to file
         if format.lower() == "yaml":
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 yaml.dump(discussions_data, f, default_flow_style=False, sort_keys=False)
         else:
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 json.dump(discussions_data, f, indent=2)
 
         # Create summary table
@@ -3672,7 +3672,7 @@ def schedule_add(
         navig github schedule-add weekly-full --profile full-backup --interval weekly --on monday --at 03:00
         navig github schedule-add frequent --profile quick --interval "every 6 hours"
     """
-    from .scheduler import BackupScheduler, create_scheduled_backup
+    from .scheduler import BackupScheduler, ScheduleStoreError, create_scheduled_backup
 
     scheduler = BackupScheduler()
     backup = create_scheduled_backup(
@@ -3683,7 +3683,12 @@ def schedule_add(
         on_day=on_day,
     )
 
-    scheduler.add_backup(backup)
+    try:
+        scheduler.add_backup(backup)
+    except ScheduleStoreError as e:
+        print_error(f"Could not read existing schedules — not saving, to avoid losing them: {e}")
+        console.print("   [dim]The schedule store is temporarily locked; try again in a moment.[/dim]")
+        sys.exit(1)
     print_success(f"Scheduled backup '{name}' added!")
     console.print(f"   [dim]Interval: {interval}[/dim]")
     if at_time:
@@ -3748,10 +3753,16 @@ def schedule_remove(
     Example:
         navig github schedule-remove daily-backup
     """
-    from .scheduler import BackupScheduler
+    from .scheduler import BackupScheduler, ScheduleStoreError
 
     scheduler = BackupScheduler()
-    if scheduler.remove_backup(name):
+    try:
+        removed = scheduler.remove_backup(name)
+    except ScheduleStoreError as e:
+        print_error(f"Could not read existing schedules — not saving, to avoid losing them: {e}")
+        console.print("   [dim]The schedule store is temporarily locked; try again in a moment.[/dim]")
+        sys.exit(1)
+    if removed:
         print_success(f"Schedule '{name}' removed")
     else:
         print_error(f"Schedule '{name}' not found")
@@ -4185,10 +4196,10 @@ def projects(
 
         # Export to file
         if format.lower() == "yaml":
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 yaml.dump(projects_data, f, default_flow_style=False, sort_keys=False)
         else:
-            with open(dest, "w") as f:
+            with open(dest, "w", encoding="utf-8") as f:
                 json.dump(projects_data, f, indent=2)
 
         # Create summary table
@@ -4260,7 +4271,7 @@ def analytics_report(
     report = analytics.generate_report(format=format.lower())
 
     if output:
-        output.write_text(report)
+        output.write_text(report, encoding="utf-8")
         print_success(f"Report saved to: {output}")
     else:
         console.print(report)
@@ -4385,7 +4396,7 @@ def diff_backups(
     report = compare.generate_diff_report(diff, format=format.lower())
 
     if output:
-        output.write_text(report)
+        output.write_text(report, encoding="utf-8")
         print_success(f"Diff report saved to: {output}")
     else:
         console.print(report)
@@ -4535,9 +4546,14 @@ def show_template(
     console.print(table)
 
     if template.schedule_interval:
-        console.print(f"\n   [cyan]📅 Schedule: {template.schedule_interval}")
+        # Rich parses each print() independently, so a style opened in one call does not
+        # carry into the next. Splitting `[cyan]…[/cyan]` across two prints left the
+        # second holding a closing tag with no opener, and Rich raises MarkupError on
+        # that rather than ignoring it — `template-show` crashed for any template with
+        # both an interval and a time. Each line now opens and closes its own tag.
+        console.print(f"\n   [cyan]📅 Schedule: {template.schedule_interval}[/cyan]")
         if template.schedule_time:
-            console.print(f"      At: {template.schedule_time}[/cyan]")
+            console.print(f"      [cyan]At: {template.schedule_time}[/cyan]")
 
 
 @app.command("template-use")
@@ -4725,7 +4741,7 @@ def test_notifications() -> None:
 
     if not manager.providers:
         print_warning("No notification providers configured")
-        console.print("   [dim]Configure notifications in ~/.config/the engine/.the engine_notifications.json[/dim]")
+        console.print("   [dim]Configure notifications in ~/.config/navig-github/.navig-github_notifications.json[/dim]")
         return
 
     console.print("\n[cyan]🔔 Testing notification providers...[/cyan]")