reveal-cli 0.8.0__py3-none-any.whl

reveal_cli-0.8.0.dist-info/METADATA

@@ -0,0 +1,352 @@
+Metadata-Version: 2.4
+Name: reveal-cli
+Version: 0.8.0
+Summary: Semantic code exploration with progressive disclosure - explore directories, files, and code elements with smart defaults
+Author-email: Progressive Reveal Contributors <scottsen@users.noreply.github.com>
+License: MIT
+Project-URL: Homepage, https://github.com/scottsen/reveal
+Project-URL: Repository, https://github.com/scottsen/reveal
+Project-URL: Documentation, https://github.com/scottsen/reveal/tree/main/docs
+Project-URL: Bug Tracker, https://github.com/scottsen/reveal/issues
+Project-URL: Discussions, https://github.com/scottsen/reveal/discussions
+Project-URL: Changelog, https://github.com/scottsen/reveal/releases
+Keywords: cli,file-explorer,ai,agentic,progressive-disclosure,code-analysis
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: tree-sitter==0.21.3
+Requires-Dist: tree-sitter-languages>=1.10.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Provides-Extra: treesitter
+Provides-Extra: excel
+Requires-Dist: openpyxl>=3.0; extra == "excel"
+Provides-Extra: syntax
+Requires-Dist: pygments>=2.0; extra == "syntax"
+Dynamic: license-file
+
+# reveal - Explore Code Semantically
+
+> **The simplest way to understand code**
+>
+> Point it at a directory, file, or function. Get exactly what you need with zero configuration.
+
+## 🎯 The Problem
+
+Developers and AI agents waste time reading entire files when they only need to understand structure or extract specific functions. There's no standard way to progressively explore code.
+
+## 💡 The Solution
+
+`reveal` provides smart, semantic exploration of codebases:
+- **Directories** → See what's inside
+- **Files** → See structure (imports, functions, classes)
+- **Elements** → See implementation (extract specific function/class)
+
+All with perfect `filename:line` integration for vim, git, grep, and other tools.
+
+## ⚡ Quick Start
+
+**Install:**
+```bash
+pip install reveal-cli
+```
+
+Includes full support for 18 file types out of the box (Python, JavaScript, TypeScript, Rust, Go, and more).
+
+**Use:**
+```bash
+reveal src/                    # Directory → tree view
+reveal app.py                  # File → structure
+reveal app.py load_config      # Element → extraction
+```
+
+**That's it.** No flags, no configuration, just works.
+
+## 🎨 Clean Design
+
+### Smart Auto-Detection
+
+```bash
+# Directories → tree view
+$ reveal src/
+📁 src/
+├── app.py (247 lines, Python)
+├── database.py (189 lines, Python)
+└── models/
+    ├── user.py (156 lines, Python)
+    └── post.py (203 lines, Python)
+
+# Files → structure view
+$ reveal app.py
+📄 app.py
+
+Imports (3):
+  app.py:1    import os, sys
+  app.py:2    from typing import Dict
+
+Functions (5):
+  app.py:15   load_config(path: str) -> Dict
+  app.py:28   setup_logging(level: str) -> None
+
+Classes (2):
+  app.py:95   Database
+  app.py:145  RequestHandler
+
+# Elements → extraction
+$ reveal app.py load_config
+app.py:15-27 | load_config
+
+   15  def load_config(path: str) -> Dict:
+   16      """Load configuration from JSON file."""
+   17
+   18      if not os.path.exists(path):
+   19          raise FileNotFoundError(f"Config not found: {path}")
+   20
+   21      with open(path) as f:
+   22          return json.load(f)
+```
+
+### Perfect Unix Integration
+
+Every line is `filename:line` format:
+
+```bash
+# Works with vim
+$ reveal app.py | grep "Database"
+  app.py:95     Database
+
+$ vim app.py:95
+
+# Works with git
+$ reveal app.py | grep "load_config"
+  app.py:15   load_config(path: str) -> Dict
+
+$ git blame app.py -L 15,27
+
+# Pipe to other tools
+$ reveal app.py --format=grep | grep "config"
+app.py:15:def load_config(path: str) -> Dict:
+app.py:18:    if not os.path.exists(path):
+```
+
+## 🔌 Adding New File Types (Stupidly Easy)
+
+### Tree-Sitter Languages (10 lines!)
+
+```python
+from reveal import TreeSitterAnalyzer, register
+
+@register('.go', name='Go', icon='🔷')
+class GoAnalyzer(TreeSitterAnalyzer):
+    language = 'go'
+```
+
+**Done!** Full Go support with structure extraction and element access.
+
+Works for: Python, Rust, Go, JavaScript, TypeScript, C#, Java, PHP, Bash, C, C++, Swift, Kotlin, and 40+ more languages!
+
+### Custom Analyzers (20-50 lines)
+
+```python
+from reveal import FileAnalyzer, register
+
+@register('.md', name='Markdown', icon='📝')
+class MarkdownAnalyzer(FileAnalyzer):
+    def get_structure(self):
+        """Extract headings."""
+        headings = []
+        for i, line in enumerate(self.lines, 1):
+            if line.startswith('#'):
+                headings.append({'line': i, 'name': line.strip('# ')})
+        return {'headings': headings}
+
+    def extract_element(self, element_type, name):
+        """Extract a section."""
+        # Custom extraction logic
+        ...
+```
+
+That's it! Your file type now works with reveal.
+
+## 🚀 Features
+
+- ✅ **Smart defaults** - No flags needed for 99% of use cases
+- ✅ **Directory trees** - See what's in a folder
+- ✅ **Structure extraction** - Imports, functions, classes, signals (GDScript)
+- ✅ **Element extraction** - Get specific function/class
+- ✅ **18 file types built-in** - Python, Rust, Go, JavaScript, TypeScript, GDScript, Bash, Jupyter, Markdown, JSON, YAML, TOML, Nginx, Dockerfile, and more
+- ✅ **Shebang detection** - Extensionless scripts work automatically (detects `#!/usr/bin/env python3`, `#!/bin/bash`)
+- ✅ **50+ languages available** - Via optional tree-sitter (JS, TS, C#, Java, PHP, etc.)
+- ✅ **Perfect line numbers** - `filename:line` format everywhere
+- ✅ **Unix composable** - Works with vim, git, grep, sed, awk
+- ✅ **Multiple output formats** - text (default), json, grep
+- ✅ **Easy to extend** - Add new file type in 10-50 lines
+- ✅ **AI-optimized** - Designed for agentic workflows
+- ✅ **Windows compatible** - Full UTF-8/emoji support
+
+## 📚 Real-World Examples
+
+### AI Agent Workflow
+```bash
+# Start broad
+$ reveal src/
+# Pick interesting file
+$ reveal src/app.py
+# Deep dive
+$ reveal src/app.py Database
+```
+
+### Developer Quick Lookup
+```bash
+# See function implementation
+$ reveal app.py load_config
+
+# Jump to edit
+$ vim app.py:15
+```
+
+### Game Development (GDScript)
+```bash
+# Explore Godot scripts
+$ reveal player.gd
+📄 player.gd
+
+Functions (4):
+  player.gd:11    _ready() -> void
+  player.gd:16    take_damage(amount: int) -> void
+  player.gd:24    die() -> void
+
+Signals (2):
+  player.gd:3     health_changed(new_health)
+  player.gd:4     died()
+
+# Extract specific function
+$ reveal player.gd take_damage
+player.gd:16-23 | take_damage
+
+   16  func take_damage(amount: int) -> void:
+   17      """Reduce health by amount."""
+   18      current_health -= amount
+   19      emit_signal("health_changed", current_health)
+```
+
+### Integration with Tools
+```bash
+# Find all TODO comments
+$ reveal src/*.py | grep -i "todo"
+
+# Count functions per file
+$ for f in src/*.py; do echo "$f: $(reveal $f | grep -c 'Functions')"; done
+
+# Extract all function names
+$ reveal app.py | awk '/Functions/,/^$/ {if ($2 ~ /:/) print $3}'
+```
+
+## 🎯 Use Cases
+
+**For AI Agents:**
+- Explore unknown codebases efficiently
+- Get structure without reading full files
+- Extract specific elements on demand
+- Standard interface across all file types
+
+**For Developers:**
+- Quick reference without opening editor
+- Understand file structure rapidly
+- Find specific functions/classes
+- Perfect for terminal workflows
+
+**For Scripts:**
+- JSON output for programmatic access
+- Grep-compatible format
+- Composable with Unix tools
+- Reliable filename:line references
+
+## 🏗️ Architecture
+
+```
+reveal/
+├── base.py              # FileAnalyzer base class
+├── treesitter.py        # TreeSitterAnalyzer (50+ languages!)
+├── tree_view.py         # Directory tree view
+├── new_cli.py           # Simple CLI (200 lines)
+└── analyzers_new/
+    ├── python.py        # 15 lines
+    ├── rust.py          # 13 lines
+    ├── go.py            # 13 lines
+    ├── markdown.py      # 79 lines
+    ├── yaml_json.py     # 110 lines
+    └── ...              # Easy to add more!
+```
+
+**Total core:** ~500 lines
+**Per analyzer:** 10-50 lines
+
+## 📖 Optional Flags
+
+```bash
+# Discovery
+reveal --version              # Show version
+reveal --list-supported       # List all supported file types
+
+# Metadata only
+reveal app.py --meta
+
+# JSON output
+reveal app.py --format=json
+
+# Grep-compatible output
+reveal app.py --format=grep
+
+# Directory depth
+reveal src/ --depth=5
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Adding a new file type takes 10-50 lines of code.
+
+**Most wanted:**
+- New language analyzers (TypeScript, Java, Swift, Kotlin)
+- Better extraction logic for existing analyzers
+- Documentation improvements
+- Bug reports and feature requests
+
+## 📜 License
+
+MIT License - See [LICENSE](LICENSE)
+
+## 🔗 Links
+
+- **GitHub:** https://github.com/scottsen/reveal
+- **Issues:** https://github.com/scottsen/reveal/issues
+- **Discussions:** https://github.com/scottsen/reveal/discussions
+
+## 🌟 Vision
+
+Make `reveal` the standard way to explore code - for humans and AI agents alike. Clean, simple, powerful.
+
+---
+
+**Status:** 🚀 v0.4.0 - Enhanced CLI + Cross-Platform | **License:** MIT
+
+[![GitHub Stars](https://img.shields.io/github/stars/scottsen/reveal?style=social)](https://github.com/scottsen/reveal)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)

reveal_cli-0.8.0.dist-info/RECORD

@@ -0,0 +1,33 @@
+plugins/c-header.yaml,sha256=sRAek7FbWTq9Fe18dH0ZbGS5Dq0fbAYmY3SK7SSQfpg,2171
+plugins/gdscript.yaml,sha256=HEo6D4AGkl0LUo7H85-bR81DrjQ7HBFCHm1KqoENOwg,2603
+plugins/python.yaml,sha256=213ql1rlRsm1BY_2toh0_aRRWQEGCP8McSQePCsk2ng,2558
+plugins/yaml.yaml,sha256=ItDYralLAwDdKHA_V-MIIVKh2f1fpxRc_R0UeGxArww,2061
+reveal/__init__.py,sha256=Xyft2Ri_HeIQCVFhKZsO0N1MRCFPg_kzAt4PVVyJMHc,644
+reveal/base.py,sha256=4KiQ-Q42erhzO03BnqYsYF3YttYd0gOGCqyDJ3-eAWg,7872
+reveal/main.py,sha256=fgzjYq8qKaZK5JxWK50xIjGLEzO0MvYTG1DHUmsf4lY,11984
+reveal/tree_view.py,sha256=xgaVy4cbM6Ug0EAF6ITUgNL6ZJLqxX7SnIPHkXbypTw,3016
+reveal/treesitter.py,sha256=lueEwthz9Csm6icV4e4U4kOvRZowkuWRtdN2zDk9RuA,9726
+reveal/analyzers/__init__.py,sha256=A1wvQ0be9je_gF2xZp9YY4qaxYRhg4USrqyviIHjuNo,1046
+reveal/analyzers/bash.py,sha256=N6PejKPwRPuL1BGlgV78486iyspZ3bgw1YvZG5yUghw,1484
+reveal/analyzers/dockerfile.py,sha256=_4QKDmLrYbwER8p9gC5RL4EmmCcqg5KBNA1eGn4kQcE,5265
+reveal/analyzers/gdscript.py,sha256=HNwF54p65sIDlBY74iHzLPMG1NUv36qesGcoDlaLDqY,6765
+reveal/analyzers/go.py,sha256=sylABSwHp_jSPm7eHKq2ipNmTd0IV9mBb0JA15Rnfn0,284
+reveal/analyzers/javascript.py,sha256=A-decthjc94-cezrXRC-wteEHgQ820J5oWPbPRm8dKo,530
+reveal/analyzers/jupyter_analyzer.py,sha256=6yz6poGJYRGdtq3IxR1Y-cijaFeIpZ4A5oMH6JMb_18,8723
+reveal/analyzers/markdown.py,sha256=STcES1x_f9tKjdCgvZDeno4cSKbT4iMTEDItmNsInh8,2401
+reveal/analyzers/nginx.py,sha256=uZyyDO0A3IFCJGhwvxpA8THXunrSYweln7poHawT07A,7108
+reveal/analyzers/python.py,sha256=qbPttzQzOMoWGYcpvwxGTZaBFLBduzZglj7AVBCle-U,389
+reveal/analyzers/rust.py,sha256=ogeRQvUfvgih1b5QfgslrDk_pc2dlCNbgYEqz66HWF0,296
+reveal/analyzers/toml.py,sha256=U3nuBzjCX3NdMqXU4xxVRmUoAh5SVCsDS-uJdbyy8wo,3014
+reveal/analyzers/typescript.py,sha256=p35mvBVsPx8bADzJhjhH9ggShPHAx7LBXSOEIUlfHiw,667
+reveal/analyzers/yaml_json.py,sha256=uyEZ_Y24BK7eET8xYbE8Q4rAIO5CXwStMwf_l3vsvF8,3066
+reveal/tests/__init__.py,sha256=meoUhQILMxty6Gk_XHj0-zbKRn711fTxZ6JIMc2Y7JU,29
+reveal/tests/test_json_yaml_line_numbers.py,sha256=mEUGR5_BMco_0N3Bf9hVRgDrdPVKmQsmog6rsAkb0BU,7649
+reveal/tests/test_line_numbers.py,sha256=3oeC8rc_ofhGaXK-6HDyBJwyUZGMtjIcRSrRLLvYZrw,5137
+reveal/tests/test_toml_analyzer.py,sha256=4SAdDYYfA3paCWWS-tw3ZKxVPt9X00wCj0YQfUYl154,7051
+reveal_cli-0.8.0.dist-info/licenses/LICENSE,sha256=KJ5Eu4wDOnBsoZhjgPVzNtU-_R0eCEaSRo-bEFFwLSE,1088
+reveal_cli-0.8.0.dist-info/METADATA,sha256=nNXurr6pYv6821z4WmayrLRjqeRc2k6flOsiToBrosc,10357
+reveal_cli-0.8.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+reveal_cli-0.8.0.dist-info/entry_points.txt,sha256=_EMjogo56bn7uRIjUkHXWr7MYb09640wCTvuPhYBJug,44
+reveal_cli-0.8.0.dist-info/top_level.txt,sha256=x35WvsdwMGe0jIYO57z-HxlnZLdyK6STnD7fSKfZATI,15
+reveal_cli-0.8.0.dist-info/RECORD,,

reveal_cli-0.8.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

reveal_cli-0.8.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+reveal = reveal.main:main

reveal_cli-0.8.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Progressive Reveal Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

reveal_cli-0.8.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+plugins
+reveal