contextly 0.1.7__tar.gz → 1.0.2__tar.gz

contextly-1.0.2/PKG-INFO

@@ -0,0 +1,294 @@
+Metadata-Version: 2.4
+Name: contextly
+Version: 1.0.2
+Summary: The ultimate context-engineering workspace CLI for LLMs.
+Author: Contextly Team
+Project-URL: Homepage, https://github.com/vutikurishanmukha9/Contextly
+Project-URL: Repository, https://github.com/vutikurishanmukha9/Contextly.git
+Project-URL: Changelog, https://github.com/vutikurishanmukha9/Contextly/blob/main/cli/CHANGELOG.md
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: typer>=0.12.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pathspec>=0.12.0
+Requires-Dist: pyperclip>=1.8.2
+Requires-Dist: tomli>=2.0.1
+Requires-Dist: tiktoken>=0.7.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+
+# Context-Ly CLI
+
+**Context-Ly CLI** is an open-source Context Intelligence Engine designed to help developers generate high-quality, token-efficient context for Large Language Models (LLMs).
+
+Rather than manually explaining your project to an AI assistant in every session, Context-Ly analyzes your repository, discovers conventions, learns team rules, and generates structured context files that help AI tools understand your codebase more effectively.
+
+The CLI acts as a persistent **Context Memory Layer** for your repository, enabling consistent AI interactions across development workflows.
+
+---
+
+## Features
+
+* Repository analysis and context generation
+* Automatic framework and dependency detection
+* Architecture visualization through project structure analysis
+* Team convention discovery and memory management
+* Persistent project-specific context storage
+* LLM-ready Context Pack generation
+* Repository complexity and token usage inspection
+* Context-as-Code workflow with version-controlled project memory
+
+---
+
+## Installation
+
+Install Context-Ly directly from PyPI:
+
+```bash
+pip install contextly
+```
+
+Verify the installation:
+
+```bash
+contextly --help
+```
+
+---
+
+## Prerequisites
+
+* Python 3.9 or later
+* A local Git repository or project directory to analyze
+
+No external services or API keys are required for the core functionality.
+
+---
+
+## Quick Start
+
+Initialize Context-Ly in your project:
+
+```bash
+contextly init
+```
+
+Analyze your repository and generate a complete project context:
+
+```bash
+contextly analyze
+```
+
+This command automatically:
+
+* Reads your README documentation
+* Scans the project structure
+* Detects frameworks and dependencies
+* Discovers conventions and stored memory
+* Generates a comprehensive `PROJECT_CONTEXT.md`
+
+The generated file can be used directly with AI coding assistants and LLMs.
+
+---
+
+## Commands
+
+### `contextly init`
+
+Initialize Context-Ly in the current project.
+
+```bash
+contextly init
+```
+
+Creates:
+
+```text
+.contextly/
+├── config.yaml
+├── memory/
+└── packs/
+```
+
+---
+
+### `contextly analyze`
+
+Generate a complete repository context file.
+
+```bash
+contextly analyze
+```
+
+This command:
+
+* Reads project documentation
+* Analyzes repository structure
+* Detects frameworks and technologies
+* Loads stored team conventions
+* Generates `PROJECT_CONTEXT.md`
+
+Output:
+
+```text
+PROJECT_CONTEXT.md
+```
+
+---
+
+### `contextly discover`
+
+Run the Pattern Discovery Engine.
+
+```bash
+contextly discover
+```
+
+Discovers repository conventions such as:
+
+* TailwindCSS usage
+* Zustand state management
+* React Query patterns
+* Service-layer architecture hints
+* Framework-specific conventions
+
+The command provides insight into patterns already present within the codebase.
+
+---
+
+### `contextly learn --auto`
+
+Convert discovered conventions into permanent project memory.
+
+```bash
+contextly learn --auto
+```
+
+Example:
+
+```text
+Save convention: TailwindCSS (Uses TailwindCSS for styling.)? [y/N]
+```
+
+Approved conventions are stored in:
+
+```text
+.contextly/memory/rules.yaml
+```
+
+This creates a persistent memory layer that can be committed to source control and shared across teams.
+
+---
+
+### `contextly memory`
+
+Inspect all stored project memory and conventions.
+
+```bash
+contextly memory
+```
+
+Displays all saved rules, conventions, and architectural preferences currently remembered by Context-Ly.
+
+---
+
+### `contextly pack <directory>`
+
+Generate an LLM-ready Context Pack from a specific directory.
+
+```bash
+contextly pack src/components
+```
+
+The command:
+
+* Reads all files in the target directory
+* Calculates token usage
+* Bundles the content into a reusable Context Pack
+
+Output location:
+
+```text
+.contextly/packs/
+```
+
+Useful for sharing focused portions of a large codebase with an LLM.
+
+---
+
+### `contextly inspect`
+
+Analyze repository complexity and token consumption.
+
+```bash
+contextly inspect
+```
+
+Provides visibility into:
+
+* Large files
+* Potential token-heavy directories
+* Context window bottlenecks
+* Repository complexity hotspots
+
+This helps identify areas that may negatively impact AI context quality.
+
+---
+
+## Example Workflow
+
+```bash
+contextly init
+
+contextly discover
+
+contextly learn --auto
+
+contextly analyze
+```
+
+Result:
+
+```text
+.contextly/
+PROJECT_CONTEXT.md
+```
+
+Your repository now has a persistent memory layer and an AI-ready context file generated from both repository analysis and learned team conventions.
+
+---
+
+## Why Context-Ly?
+
+Modern AI coding tools are powerful, but they often lack project-specific context.
+
+Context-Ly bridges that gap by transforming repository knowledge, team conventions, and architectural patterns into structured context that can be consistently shared with LLMs.
+
+The goal is simple:
+
+**Build context once. Use it everywhere.**
+
+---
+
+## Changelog
+
+For all release notes and version history, please see the [CHANGELOG.md](https://github.com/vutikurishanmukha9/Contextly/blob/main/cli/CHANGELOG.md).
+
+---
+
+## Contributing
+
+Contributions, issues, and feature requests are welcome.
+
+If you discover a bug, have an idea for improving repository intelligence, or want to contribute new scanners and analysis capabilities, please open an issue or submit a pull request.
+
+---
+
+## License
+
+This project is open source and distributed under the terms of its license.
+
+See the LICENSE file for details.

contextly-1.0.2/README.md

@@ -0,0 +1,272 @@
+# Context-Ly CLI
+
+**Context-Ly CLI** is an open-source Context Intelligence Engine designed to help developers generate high-quality, token-efficient context for Large Language Models (LLMs).
+
+Rather than manually explaining your project to an AI assistant in every session, Context-Ly analyzes your repository, discovers conventions, learns team rules, and generates structured context files that help AI tools understand your codebase more effectively.
+
+The CLI acts as a persistent **Context Memory Layer** for your repository, enabling consistent AI interactions across development workflows.
+
+---
+
+## Features
+
+* Repository analysis and context generation
+* Automatic framework and dependency detection
+* Architecture visualization through project structure analysis
+* Team convention discovery and memory management
+* Persistent project-specific context storage
+* LLM-ready Context Pack generation
+* Repository complexity and token usage inspection
+* Context-as-Code workflow with version-controlled project memory
+
+---
+
+## Installation
+
+Install Context-Ly directly from PyPI:
+
+```bash
+pip install contextly
+```
+
+Verify the installation:
+
+```bash
+contextly --help
+```
+
+---
+
+## Prerequisites
+
+* Python 3.9 or later
+* A local Git repository or project directory to analyze
+
+No external services or API keys are required for the core functionality.
+
+---
+
+## Quick Start
+
+Initialize Context-Ly in your project:
+
+```bash
+contextly init
+```
+
+Analyze your repository and generate a complete project context:
+
+```bash
+contextly analyze
+```
+
+This command automatically:
+
+* Reads your README documentation
+* Scans the project structure
+* Detects frameworks and dependencies
+* Discovers conventions and stored memory
+* Generates a comprehensive `PROJECT_CONTEXT.md`
+
+The generated file can be used directly with AI coding assistants and LLMs.
+
+---
+
+## Commands
+
+### `contextly init`
+
+Initialize Context-Ly in the current project.
+
+```bash
+contextly init
+```
+
+Creates:
+
+```text
+.contextly/
+├── config.yaml
+├── memory/
+└── packs/
+```
+
+---
+
+### `contextly analyze`
+
+Generate a complete repository context file.
+
+```bash
+contextly analyze
+```
+
+This command:
+
+* Reads project documentation
+* Analyzes repository structure
+* Detects frameworks and technologies
+* Loads stored team conventions
+* Generates `PROJECT_CONTEXT.md`
+
+Output:
+
+```text
+PROJECT_CONTEXT.md
+```
+
+---
+
+### `contextly discover`
+
+Run the Pattern Discovery Engine.
+
+```bash
+contextly discover
+```
+
+Discovers repository conventions such as:
+
+* TailwindCSS usage
+* Zustand state management
+* React Query patterns
+* Service-layer architecture hints
+* Framework-specific conventions
+
+The command provides insight into patterns already present within the codebase.
+
+---
+
+### `contextly learn --auto`
+
+Convert discovered conventions into permanent project memory.
+
+```bash
+contextly learn --auto
+```
+
+Example:
+
+```text
+Save convention: TailwindCSS (Uses TailwindCSS for styling.)? [y/N]
+```
+
+Approved conventions are stored in:
+
+```text
+.contextly/memory/rules.yaml
+```
+
+This creates a persistent memory layer that can be committed to source control and shared across teams.
+
+---
+
+### `contextly memory`
+
+Inspect all stored project memory and conventions.
+
+```bash
+contextly memory
+```
+
+Displays all saved rules, conventions, and architectural preferences currently remembered by Context-Ly.
+
+---
+
+### `contextly pack <directory>`
+
+Generate an LLM-ready Context Pack from a specific directory.
+
+```bash
+contextly pack src/components
+```
+
+The command:
+
+* Reads all files in the target directory
+* Calculates token usage
+* Bundles the content into a reusable Context Pack
+
+Output location:
+
+```text
+.contextly/packs/
+```
+
+Useful for sharing focused portions of a large codebase with an LLM.
+
+---
+
+### `contextly inspect`
+
+Analyze repository complexity and token consumption.
+
+```bash
+contextly inspect
+```
+
+Provides visibility into:
+
+* Large files
+* Potential token-heavy directories
+* Context window bottlenecks
+* Repository complexity hotspots
+
+This helps identify areas that may negatively impact AI context quality.
+
+---
+
+## Example Workflow
+
+```bash
+contextly init
+
+contextly discover
+
+contextly learn --auto
+
+contextly analyze
+```
+
+Result:
+
+```text
+.contextly/
+PROJECT_CONTEXT.md
+```
+
+Your repository now has a persistent memory layer and an AI-ready context file generated from both repository analysis and learned team conventions.
+
+---
+
+## Why Context-Ly?
+
+Modern AI coding tools are powerful, but they often lack project-specific context.
+
+Context-Ly bridges that gap by transforming repository knowledge, team conventions, and architectural patterns into structured context that can be consistently shared with LLMs.
+
+The goal is simple:
+
+**Build context once. Use it everywhere.**
+
+---
+
+## Changelog
+
+For all release notes and version history, please see the [CHANGELOG.md](https://github.com/vutikurishanmukha9/Contextly/blob/main/cli/CHANGELOG.md).
+
+---
+
+## Contributing
+
+Contributions, issues, and feature requests are welcome.
+
+If you discover a bug, have an idea for improving repository intelligence, or want to contribute new scanners and analysis capabilities, please open an issue or submit a pull request.
+
+---
+
+## License
+
+This project is open source and distributed under the terms of its license.
+
+See the LICENSE file for details.

contextly-1.0.2/contextly/__init__.py

@@ -0,0 +1 @@
+# Contextly CLI Package

contextly-1.0.2/contextly/commands/__init__.py

@@ -0,0 +1 @@
+# Init commands

contextly-1.0.2/contextly/commands/analyze.py

@@ -0,0 +1,49 @@
+from pathlib import Path
+from rich.table import Table
+import typer
+
+from ..utils.console import console
+from ..scanners.base import ScannerError
+from ..utils.exceptions import ContextlyError
+from ..core.analyzer.engine import AnalyzerEngine
+
+def analyze_cmd(model: str = typer.Option("chatgpt", "--model", "-m", help="Target LLM format ('chatgpt' or 'claude')")):
+    """Automatically analyze and map the repository"""
+    root_dir = Path.cwd()
+    engine = AnalyzerEngine(root_dir)
+    
+    with console.status("[bold blue]Scanning repository intelligence (Max Level)...", spinner="dots"):
+        try:
+            intelligence = engine.analyze(model)
+        except ScannerError as e:
+            console.print(f"\n[bold red]Scanner Error:[/bold red] {e}")
+            raise typer.Exit(1)
+        except ContextlyError as e:
+            console.print(f"\n[bold red]Context-Ly Error:[/bold red] {e}")
+            raise typer.Exit(1)
+        except Exception as e:
+            console.print(f"\n[bold red]Unexpected Error:[/bold red] {e}")
+            raise typer.Exit(1)
+            
+    console.print("\n[bold green][OK][/bold green] Repository scan complete!\n")
+    
+    table = Table(title="Repository Intelligence (Max Level)", show_header=False, box=None)
+    table.add_column("Category", style="cyan", justify="right")
+    table.add_column("Value", style="magenta")
+    
+    table.add_row("Primary Language", f"[bold]{intelligence.language.primary}[/bold]")
+    table.add_row("Frontend Framework", intelligence.frameworks.frontend)
+    table.add_row("Backend/Tooling", intelligence.frameworks.backend)
+    
+    npm_count = len(intelligence.dependencies.npm)
+    py_count = len(intelligence.dependencies.python)
+    
+    if npm_count > 0:
+        table.add_row("NPM Dependencies", str(npm_count))
+    if py_count > 0:
+        table.add_row("Python Dependencies", str(py_count))
+        
+    console.print(table)
+    console.print()
+    console.print(f"[dim]Generated advanced PROJECT_CONTEXT.md ({model.lower()} format) in current directory.[/dim]")
+

contextly-1.0.2/contextly/commands/discover.py

@@ -0,0 +1,51 @@
+from pathlib import Path
+import typer
+
+from ..utils.console import console
+from ..core.discovery.engine import DiscoveryEngine
+from ..scanners.base import ScannerError
+from ..utils.exceptions import ValidationError, ContextlyError
+from ..utils.validation import require_contextly_initialized
+
+def discover_cmd():
+    """Statically analyze the repository to discover architectural patterns and conventions"""
+    root_dir = Path.cwd()
+    
+    try:
+        require_contextly_initialized(root_dir)
+    except ValidationError as e:
+        console.print(f"[bold red]Error:[/bold red] {e}")
+        raise typer.Exit(code=1)
+        
+    engine = DiscoveryEngine(root_dir)
+        
+    with console.status("[bold blue]Running Pattern Discovery Engine...", spinner="dots"):
+        try:
+            patterns_result = engine.discover()
+        except ScannerError as e:
+            console.print(f"\n[bold red]Scanner Error:[/bold red] {e}")
+            raise typer.Exit(code=1)
+        except ContextlyError as e:
+            console.print(f"\n[bold red]Context-Ly Error:[/bold red] {e}")
+            raise typer.Exit(code=1)
+        
+    console.print("[bold green][OK][/bold green] Pattern Discovery Complete:\n")
+    
+    if not patterns_result.patterns:
+        console.print("[yellow]No recognizable architectural patterns or conventions discovered.[/yellow]")
+        return
+
+    # Group by category
+    categories = {}
+    for p in patterns_result.patterns:
+        if p.category not in categories:
+            categories[p.category] = []
+        categories[p.category].append(p)
+        
+    for category, patterns in sorted(categories.items()):
+        console.print(f"[bold cyan]{category}:[/bold cyan]")
+        # Sort by confidence descending (High -> Medium -> Low)
+        sorted_patterns = sorted(patterns, key=lambda p: {"high": 0, "medium": 1, "low": 2}.get(p.confidence.lower(), 3))
+        for p in sorted_patterns:
+            console.print(f"  [green]\\[OK][/green] [bold]{p.name}[/bold] ({p.description})")
+        console.print()

contextly-1.0.2/contextly/commands/export.py

@@ -0,0 +1,42 @@
+import typer
+from pathlib import Path
+from ..utils.console import console
+from ..core.exporter.engine import ExporterEngine
+from ..utils.validation import require_contextly_initialized
+from ..utils.exceptions import ValidationError, ContextlyError
+
+def export_cmd(
+    pack_name: str = typer.Argument(..., help="The name of the context pack to export (e.g., 'frontend')")
+):
+    """Fuses intelligence and context packs, copying the result to your clipboard."""
+    root_dir = Path.cwd()
+    
+    try:
+        require_contextly_initialized(root_dir)
+    except ValidationError as e:
+        console.print(f"[bold red]Error:[/bold red] {e}")
+        raise typer.Exit(code=1)
+        
+    engine = ExporterEngine(root_dir)
+    
+    try:
+        export_path, clipboard_success = engine.export(pack_name)
+    except ContextlyError as e:
+        console.print(f"[bold red]Error:[/bold red] {e}")
+        raise typer.Exit(code=1)
+        
+    if clipboard_success:
+        clipboard_status = "[green]Successfully copied to clipboard![/green]"
+    else:
+        clipboard_status = "[yellow]Could not copy to clipboard. The export file was saved successfully.[/yellow]"
+        
+    console.print(f"\n[bold green][OK][/bold green] Export Generation Complete!")
+    console.print(f"  - [cyan]Intelligence:[/cyan] PROJECT_CONTEXT.md")
+    console.print(f"  - [cyan]Context Pack:[/cyan] {pack_name}")
+    console.print(f"  - [cyan]Local Export:[/cyan] {export_path.relative_to(root_dir)}")
+    console.print(f"\n{clipboard_status}")
+    if clipboard_success:
+        console.print("\nYou can now paste the contents directly into Claude or ChatGPT.")
+    else:
+        console.print("\nOpen the local export file to copy the contents manually.")
+