devsync 0.9.0__tar.gz → 0.11.0__tar.gz

devsync-0.11.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: devsync
+Version: 0.11.0
+Summary: Distribute and sync dev tool configurations across teams
+Author-email: Troy Larson <troy@calvinware.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/troylar/devsync
+Project-URL: Documentation, https://devsync.readthedocs.io
+Project-URL: Repository, https://github.com/troylar/devsync
+Project-URL: Issues, https://github.com/troylar/devsync/issues
+Keywords: cli,ai,config,mcp,cursor,copilot,claude,cline,codex,kiro,roo,windsurf
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer[all]>=0.15.0
+Requires-Dist: rich>=14.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: textual>=6.0.0
+Requires-Dist: GitPython>=3.1.45
+Requires-Dist: python-dotenv>=1.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: black==24.10.0; extra == "dev"
+Requires-Dist: mypy>=1.10.0; extra == "dev"
+Requires-Dist: ruff>=0.9.0; extra == "dev"
+Requires-Dist: invoke>=2.0.0; extra == "dev"
+Requires-Dist: build>=1.2.1; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.12.20240808; extra == "dev"
+
+<div align="center">
+
+# DevSync
+
+**Distribute and sync AI coding assistant configurations across your team**
+
+[![CI](https://github.com/troylar/devsync/actions/workflows/ci.yml/badge.svg)](https://github.com/troylar/devsync/actions/workflows/ci.yml)
+[![Docs](https://readthedocs.org/projects/devsync/badge/?version=latest)](https://devsync.readthedocs.io)
+[![PyPI version](https://img.shields.io/pypi/v/devsync.svg)](https://pypi.org/project/devsync/)
+[![Coverage](https://codecov.io/gh/troylar/devsync/branch/main/graph/badge.svg)](https://codecov.io/gh/troylar/devsync)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Works with:** Aider | Amazon Q | Amp | Antigravity | Augment | Claude Code | Claude Desktop | Cline | Codex CLI | Continue.dev | Cursor | Gemini CLI | GitHub Copilot | JetBrains AI | Junie | Kiro | OpenCode | OpenHands | Roo Code | Tabnine | Trae | Windsurf | Zed
+
+</div>
+
+---
+
+DevSync is a CLI tool for managing AI coding assistant instructions, MCP servers, and configuration packages across 22+ IDEs. Download shared configs from Git repos, install them to any tool, and keep your team aligned.
+
+## Quick Start
+
+```bash
+pip install devsync
+
+# Check detected AI tools
+devsync tools
+
+# Download instructions from a Git repo
+devsync download --from github.com/company/standards --as company
+
+# Install interactively
+devsync install
+```
+
+## Features
+
+- **Instructions** -- share coding standards, style guides, and AI prompts from Git repos
+- **MCP Servers** -- distribute Model Context Protocol configs with secure credential management
+- **Packages** -- bundle instructions, MCP servers, hooks, commands, and resources together
+- **23 IDE integrations** -- Claude Code, Cursor, Windsurf, GitHub Copilot, and 19 more
+- **Templates** -- IDE-targeted content with slash commands, hooks, and backups
+- **Conflict resolution** -- skip, overwrite, or rename when files already exist
+
+## Documentation
+
+Full documentation at **[devsync.readthedocs.io](https://devsync.readthedocs.io)**:
+
+- [Getting Started](https://devsync.readthedocs.io/getting-started/installation/) -- installation, quickstart, core concepts
+- [CLI Reference](https://devsync.readthedocs.io/cli/) -- all commands with examples
+- [IDE Integrations](https://devsync.readthedocs.io/ide-integrations/) -- setup guides for each AI tool
+- [Packages](https://devsync.readthedocs.io/packages/) -- creating and installing config packages
+- [MCP Server](https://devsync.readthedocs.io/mcp-server/) -- MCP configuration management
+- [Tutorials](https://devsync.readthedocs.io/tutorials/team-config-repo/) -- step-by-step walkthroughs
+
+## Contributing
+
+```bash
+git clone https://github.com/troylar/devsync.git
+cd devsync
+pip install -e .[dev]
+invoke test
+```
+
+See the [contributing guide](https://devsync.readthedocs.io/advanced/contributing/) for details.
+
+## License
+
+MIT -- see [LICENSE](LICENSE).

devsync-0.11.0/README.md

@@ -0,0 +1,70 @@
+<div align="center">
+
+# DevSync
+
+**Distribute and sync AI coding assistant configurations across your team**
+
+[![CI](https://github.com/troylar/devsync/actions/workflows/ci.yml/badge.svg)](https://github.com/troylar/devsync/actions/workflows/ci.yml)
+[![Docs](https://readthedocs.org/projects/devsync/badge/?version=latest)](https://devsync.readthedocs.io)
+[![PyPI version](https://img.shields.io/pypi/v/devsync.svg)](https://pypi.org/project/devsync/)
+[![Coverage](https://codecov.io/gh/troylar/devsync/branch/main/graph/badge.svg)](https://codecov.io/gh/troylar/devsync)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Works with:** Aider | Amazon Q | Amp | Antigravity | Augment | Claude Code | Claude Desktop | Cline | Codex CLI | Continue.dev | Cursor | Gemini CLI | GitHub Copilot | JetBrains AI | Junie | Kiro | OpenCode | OpenHands | Roo Code | Tabnine | Trae | Windsurf | Zed
+
+</div>
+
+---
+
+DevSync is a CLI tool for managing AI coding assistant instructions, MCP servers, and configuration packages across 22+ IDEs. Download shared configs from Git repos, install them to any tool, and keep your team aligned.
+
+## Quick Start
+
+```bash
+pip install devsync
+
+# Check detected AI tools
+devsync tools
+
+# Download instructions from a Git repo
+devsync download --from github.com/company/standards --as company
+
+# Install interactively
+devsync install
+```
+
+## Features
+
+- **Instructions** -- share coding standards, style guides, and AI prompts from Git repos
+- **MCP Servers** -- distribute Model Context Protocol configs with secure credential management
+- **Packages** -- bundle instructions, MCP servers, hooks, commands, and resources together
+- **23 IDE integrations** -- Claude Code, Cursor, Windsurf, GitHub Copilot, and 19 more
+- **Templates** -- IDE-targeted content with slash commands, hooks, and backups
+- **Conflict resolution** -- skip, overwrite, or rename when files already exist
+
+## Documentation
+
+Full documentation at **[devsync.readthedocs.io](https://devsync.readthedocs.io)**:
+
+- [Getting Started](https://devsync.readthedocs.io/getting-started/installation/) -- installation, quickstart, core concepts
+- [CLI Reference](https://devsync.readthedocs.io/cli/) -- all commands with examples
+- [IDE Integrations](https://devsync.readthedocs.io/ide-integrations/) -- setup guides for each AI tool
+- [Packages](https://devsync.readthedocs.io/packages/) -- creating and installing config packages
+- [MCP Server](https://devsync.readthedocs.io/mcp-server/) -- MCP configuration management
+- [Tutorials](https://devsync.readthedocs.io/tutorials/team-config-repo/) -- step-by-step walkthroughs
+
+## Contributing
+
+```bash
+git clone https://github.com/troylar/devsync.git
+cd devsync
+pip install -e .[dev]
+invoke test
+```
+
+See the [contributing guide](https://devsync.readthedocs.io/advanced/contributing/) for details.
+
+## License
+
+MIT -- see [LICENSE](LICENSE).

devsync-0.11.0/devsync/ai_tools/aider.py

@@ -0,0 +1,215 @@
+"""Aider AI tool integration."""
+
+import re
+import shutil
+from pathlib import Path
+from typing import Optional
+
+from devsync.ai_tools.base import AITool
+from devsync.core.models import AIToolType, InstallationScope, Instruction
+
+START_MARKER = "<!-- devsync:start:{name} -->"
+END_MARKER = "<!-- devsync:end:{name} -->"
+SECTION_PATTERN = r"<!-- devsync:start:{name} -->\n.*?\n<!-- devsync:end:{name} -->"
+
+
+class AiderTool(AITool):
+    """Integration for Aider.
+
+    Aider reads a single CONVENTIONS.md file at the project root.
+    DevSync manages individual instruction sections using HTML comment markers:
+
+        <!-- devsync:start:instruction-name -->
+        ... instruction content ...
+        <!-- devsync:end:instruction-name -->
+    """
+
+    @property
+    def tool_type(self) -> AIToolType:
+        """Return the AI tool type identifier."""
+        return AIToolType.AIDER
+
+    @property
+    def tool_name(self) -> str:
+        """Return human-readable tool name."""
+        return "Aider"
+
+    def is_installed(self) -> bool:
+        """Check if Aider is installed on the system.
+
+        Returns:
+            True if aider binary is found on PATH or .aider.conf.yml exists
+        """
+        if shutil.which("aider") is not None:
+            return True
+        return (Path.home() / ".aider.conf.yml").exists()
+
+    def get_instructions_directory(self) -> Path:
+        """Get the directory where instructions should be installed.
+
+        Raises:
+            NotImplementedError: Aider only supports project-level installation
+        """
+        raise NotImplementedError(
+            f"{self.tool_name} global installation is not supported. "
+            "Aider uses project-level CONVENTIONS.md only. "
+            "Please use project-level installation instead (--scope project)."
+        )
+
+    def get_instruction_file_extension(self) -> str:
+        """Get the file extension for Aider instructions.
+
+        Returns:
+            File extension including the dot
+        """
+        return ".md"
+
+    def get_project_instructions_directory(self, project_root: Path) -> Path:
+        """Get the directory for project-specific Aider instructions.
+
+        CONVENTIONS.md lives at the project root.
+
+        Args:
+            project_root: Path to the project root directory
+
+        Returns:
+            Path to project root
+        """
+        return project_root
+
+    def get_instruction_path(
+        self,
+        instruction_name: str,
+        scope: InstallationScope = InstallationScope.GLOBAL,
+        project_root: Optional[Path] = None,
+    ) -> Path:
+        """Get the path to CONVENTIONS.md.
+
+        Args:
+            instruction_name: Name of the instruction (unused for path)
+            scope: Installation scope (must be PROJECT)
+            project_root: Project root path
+
+        Returns:
+            Path to CONVENTIONS.md
+
+        Raises:
+            ValueError: If scope is PROJECT but project_root is None
+            NotImplementedError: If scope is GLOBAL
+        """
+        if scope == InstallationScope.GLOBAL:
+            raise NotImplementedError(
+                f"{self.tool_name} global installation is not supported. "
+                "Please use project-level installation instead (--scope project)."
+            )
+        if project_root is None:
+            raise ValueError("project_root is required for PROJECT scope")
+        return project_root / "CONVENTIONS.md"
+
+    def instruction_exists(
+        self,
+        instruction_name: str,
+        scope: InstallationScope = InstallationScope.GLOBAL,
+        project_root: Optional[Path] = None,
+    ) -> bool:
+        """Check if an instruction section exists in CONVENTIONS.md.
+
+        Args:
+            instruction_name: Name of the instruction
+            scope: Installation scope
+            project_root: Project root path
+
+        Returns:
+            True if the instruction's section markers exist in CONVENTIONS.md
+        """
+        try:
+            path = self.get_instruction_path(instruction_name, scope, project_root)
+            if not path.exists():
+                return False
+            content = path.read_text(encoding="utf-8")
+            start = START_MARKER.format(name=instruction_name)
+            return start in content
+        except (FileNotFoundError, ValueError, NotImplementedError):
+            return False
+
+    def install_instruction(
+        self,
+        instruction: Instruction,
+        overwrite: bool = False,
+        scope: InstallationScope = InstallationScope.GLOBAL,
+        project_root: Optional[Path] = None,
+    ) -> Path:
+        """Install an instruction as a section in CONVENTIONS.md.
+
+        Args:
+            instruction: Instruction to install
+            overwrite: Whether to overwrite existing section
+            scope: Installation scope
+            project_root: Project root path
+
+        Returns:
+            Path to CONVENTIONS.md
+
+        Raises:
+            FileExistsError: If instruction section exists and overwrite=False
+        """
+        path = self.get_instruction_path(instruction.name, scope, project_root)
+
+        start = START_MARKER.format(name=instruction.name)
+        end = END_MARKER.format(name=instruction.name)
+        section = f"{start}\n{instruction.content}\n{end}"
+
+        if path.exists():
+            content = path.read_text(encoding="utf-8")
+            if start in content:
+                if not overwrite:
+                    raise FileExistsError(f"Instruction already exists in CONVENTIONS.md: {instruction.name}")
+                pattern = SECTION_PATTERN.format(name=re.escape(instruction.name))
+                content = re.sub(pattern, section, content, flags=re.DOTALL)
+                path.write_text(content, encoding="utf-8")
+                return path
+            if content and not content.endswith("\n"):
+                content += "\n"
+            content += "\n" + section + "\n"
+            path.write_text(content, encoding="utf-8")
+        else:
+            path.parent.mkdir(parents=True, exist_ok=True)
+            path.write_text(section + "\n", encoding="utf-8")
+
+        return path
+
+    def uninstall_instruction(
+        self,
+        instruction_name: str,
+        scope: InstallationScope = InstallationScope.GLOBAL,
+        project_root: Optional[Path] = None,
+    ) -> bool:
+        """Remove an instruction section from CONVENTIONS.md.
+
+        Args:
+            instruction_name: Name of instruction to remove
+            scope: Installation scope
+            project_root: Project root path
+
+        Returns:
+            True if section was removed, False if it didn't exist
+        """
+        try:
+            path = self.get_instruction_path(instruction_name, scope, project_root)
+            if not path.exists():
+                return False
+
+            content = path.read_text(encoding="utf-8")
+            start = START_MARKER.format(name=instruction_name)
+            if start not in content:
+                return False
+
+            pattern = SECTION_PATTERN.format(name=re.escape(instruction_name))
+            new_content = re.sub(pattern, "", content, flags=re.DOTALL)
+            new_content = re.sub(r"\n{3,}", "\n\n", new_content).strip()
+            if new_content:
+                new_content += "\n"
+            path.write_text(new_content, encoding="utf-8")
+            return True
+        except (FileNotFoundError, ValueError, NotImplementedError):
+            return False

devsync-0.11.0/devsync/ai_tools/amazonq.py

@@ -0,0 +1,67 @@
+"""Amazon Q AI tool integration."""
+
+import shutil
+from pathlib import Path
+
+from devsync.ai_tools.base import AITool
+from devsync.core.models import AIToolType
+
+
+class AmazonQTool(AITool):
+    """Integration for Amazon Q Developer.
+
+    Amazon Q uses .amazonq/rules/*.md for project-level instructions.
+    """
+
+    @property
+    def tool_type(self) -> AIToolType:
+        """Return the AI tool type identifier."""
+        return AIToolType.AMAZONQ
+
+    @property
+    def tool_name(self) -> str:
+        """Return human-readable tool name."""
+        return "Amazon Q"
+
+    def is_installed(self) -> bool:
+        """Check if Amazon Q is installed on the system.
+
+        Returns:
+            True if q binary is found on PATH or .amazonq/ directory exists
+        """
+        if shutil.which("q") is not None:
+            return True
+        amazonq_dir = Path.home() / ".amazonq"
+        return amazonq_dir.exists()
+
+    def get_instructions_directory(self) -> Path:
+        """Get the directory where instructions should be installed.
+
+        Raises:
+            NotImplementedError: Amazon Q only supports project-level installation
+        """
+        raise NotImplementedError(
+            f"{self.tool_name} global installation is not supported. "
+            "Please use project-level installation instead (--scope project)."
+        )
+
+    def get_instruction_file_extension(self) -> str:
+        """Get the file extension for Amazon Q instructions.
+
+        Returns:
+            File extension including the dot
+        """
+        return ".md"
+
+    def get_project_instructions_directory(self, project_root: Path) -> Path:
+        """Get the directory for project-specific Amazon Q instructions.
+
+        Args:
+            project_root: Path to the project root directory
+
+        Returns:
+            Path to project instructions directory (.amazonq/rules/)
+        """
+        instructions_dir = project_root / ".amazonq" / "rules"
+        instructions_dir.mkdir(parents=True, exist_ok=True)
+        return instructions_dir

devsync-0.11.0/devsync/ai_tools/amp.py

@@ -0,0 +1,213 @@
+"""Amp AI tool integration."""
+
+import re
+import shutil
+from pathlib import Path
+from typing import Optional
+
+from devsync.ai_tools.base import AITool
+from devsync.core.models import AIToolType, InstallationScope, Instruction
+
+START_MARKER = "<!-- devsync:start:{name} -->"
+END_MARKER = "<!-- devsync:end:{name} -->"
+SECTION_PATTERN = r"<!-- devsync:start:{name} -->\n.*?\n<!-- devsync:end:{name} -->"
+
+
+class AmpTool(AITool):
+    """Integration for Amp.
+
+    Amp reads a single AGENTS.md file at the project root.
+    DevSync manages individual instruction sections using HTML comment markers:
+
+        <!-- devsync:start:instruction-name -->
+        ... instruction content ...
+        <!-- devsync:end:instruction-name -->
+    """
+
+    @property
+    def tool_type(self) -> AIToolType:
+        """Return the AI tool type identifier."""
+        return AIToolType.AMP
+
+    @property
+    def tool_name(self) -> str:
+        """Return human-readable tool name."""
+        return "Amp"
+
+    def is_installed(self) -> bool:
+        """Check if Amp is installed on the system.
+
+        Returns:
+            True if amp binary is found on PATH
+        """
+        return shutil.which("amp") is not None
+
+    def get_instructions_directory(self) -> Path:
+        """Get the directory where instructions should be installed.
+
+        Raises:
+            NotImplementedError: Amp only supports project-level installation
+        """
+        raise NotImplementedError(
+            f"{self.tool_name} global installation is not supported. "
+            "Amp uses project-level AGENTS.md only. "
+            "Please use project-level installation instead (--scope project)."
+        )
+
+    def get_instruction_file_extension(self) -> str:
+        """Get the file extension for Amp instructions.
+
+        Returns:
+            File extension including the dot
+        """
+        return ".md"
+
+    def get_project_instructions_directory(self, project_root: Path) -> Path:
+        """Get the directory for project-specific Amp instructions.
+
+        AGENTS.md lives at the project root.
+
+        Args:
+            project_root: Path to the project root directory
+
+        Returns:
+            Path to project root
+        """
+        return project_root
+
+    def get_instruction_path(
+        self,
+        instruction_name: str,
+        scope: InstallationScope = InstallationScope.GLOBAL,
+        project_root: Optional[Path] = None,
+    ) -> Path:
+        """Get the path to AGENTS.md.
+
+        Args:
+            instruction_name: Name of the instruction (unused for path)
+            scope: Installation scope (must be PROJECT)
+            project_root: Project root path
+
+        Returns:
+            Path to AGENTS.md
+
+        Raises:
+            ValueError: If scope is PROJECT but project_root is None
+            NotImplementedError: If scope is GLOBAL
+        """
+        if scope == InstallationScope.GLOBAL:
+            raise NotImplementedError(
+                f"{self.tool_name} global installation is not supported. "
+                "Please use project-level installation instead (--scope project)."
+            )
+        if project_root is None:
+            raise ValueError("project_root is required for PROJECT scope")
+        return project_root / "AGENTS.md"
+
+    def instruction_exists(
+        self,
+        instruction_name: str,
+        scope: InstallationScope = InstallationScope.GLOBAL,
+        project_root: Optional[Path] = None,
+    ) -> bool:
+        """Check if an instruction section exists in AGENTS.md.
+
+        Args:
+            instruction_name: Name of the instruction
+            scope: Installation scope
+            project_root: Project root path
+
+        Returns:
+            True if the instruction's section markers exist in AGENTS.md
+        """
+        try:
+            path = self.get_instruction_path(instruction_name, scope, project_root)
+            if not path.exists():
+                return False
+            content = path.read_text(encoding="utf-8")
+            start = START_MARKER.format(name=instruction_name)
+            return start in content
+        except (FileNotFoundError, ValueError, NotImplementedError):
+            return False
+
+    def install_instruction(
+        self,
+        instruction: Instruction,
+        overwrite: bool = False,
+        scope: InstallationScope = InstallationScope.GLOBAL,
+        project_root: Optional[Path] = None,
+    ) -> Path:
+        """Install an instruction as a section in AGENTS.md.
+
+        Args:
+            instruction: Instruction to install
+            overwrite: Whether to overwrite existing section
+            scope: Installation scope
+            project_root: Project root path
+
+        Returns:
+            Path to AGENTS.md
+
+        Raises:
+            FileExistsError: If instruction section exists and overwrite=False
+        """
+        path = self.get_instruction_path(instruction.name, scope, project_root)
+
+        start = START_MARKER.format(name=instruction.name)
+        end = END_MARKER.format(name=instruction.name)
+        section = f"{start}\n{instruction.content}\n{end}"
+
+        if path.exists():
+            content = path.read_text(encoding="utf-8")
+            if start in content:
+                if not overwrite:
+                    raise FileExistsError(f"Instruction already exists in AGENTS.md: {instruction.name}")
+                pattern = SECTION_PATTERN.format(name=re.escape(instruction.name))
+                content = re.sub(pattern, section, content, flags=re.DOTALL)
+                path.write_text(content, encoding="utf-8")
+                return path
+            if content and not content.endswith("\n"):
+                content += "\n"
+            content += "\n" + section + "\n"
+            path.write_text(content, encoding="utf-8")
+        else:
+            path.parent.mkdir(parents=True, exist_ok=True)
+            path.write_text(section + "\n", encoding="utf-8")
+
+        return path
+
+    def uninstall_instruction(
+        self,
+        instruction_name: str,
+        scope: InstallationScope = InstallationScope.GLOBAL,
+        project_root: Optional[Path] = None,
+    ) -> bool:
+        """Remove an instruction section from AGENTS.md.
+
+        Args:
+            instruction_name: Name of instruction to remove
+            scope: Installation scope
+            project_root: Project root path
+
+        Returns:
+            True if section was removed, False if it didn't exist
+        """
+        try:
+            path = self.get_instruction_path(instruction_name, scope, project_root)
+            if not path.exists():
+                return False
+
+            content = path.read_text(encoding="utf-8")
+            start = START_MARKER.format(name=instruction_name)
+            if start not in content:
+                return False
+
+            pattern = SECTION_PATTERN.format(name=re.escape(instruction_name))
+            new_content = re.sub(pattern, "", content, flags=re.DOTALL)
+            new_content = re.sub(r"\n{3,}", "\n\n", new_content).strip()
+            if new_content:
+                new_content += "\n"
+            path.write_text(new_content, encoding="utf-8")
+            return True
+        except (FileNotFoundError, ValueError, NotImplementedError):
+            return False