cli-scry 0.1.1__py3-none-any.whl

cli_scry-0.1.1.dist-info/METADATA

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: cli-scry
+Version: 0.1.1
+Summary: Peer into any Python codebase. Discover structure, extract files, export for LLMs.
+Project-URL: Homepage, https://github.com/amdouek/scry
+Project-URL: Repository, https://github.com/amdouek/scry
+Project-URL: Issues, https://github.com/amdouek/scry/issues
+Author-email: Alon Douek <Alon.Douek@monash.edu>
+License: MIT
+License-File: LICENSE
+Keywords: cli,code-sharing,codebase,developer-tools,export,llm,project-structure,scry
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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 :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Provides-Extra: legacy
+Requires-Dist: tomli>=2.0; (python_version < '3.11') and extra == 'legacy'
+Description-Content-Type: text/markdown
+
+# scry
+
+> *Peer into any Python codebase. Discover structure, extract files, export for LLM parsing.*
+
+**scry** is a zero-dependency, single-file CLI tool that auto-discovers
+your Python project structure and lets you selectively export files for
+sharing -- in LLM chat sessions, code reviews, documentation, or
+anywhere else you need a clean, readable snapshot of your codebase.
+
+### Via pip
+```bash
+pip install cli-scry
+```
+
+### Via pipx
+```bash
+pipx install cli-scry
+```
+
+### Direct download
+```bash
+curl -O https://raw.githubusercontent.com/amdouek/scry/main/scry/cli.py
+python cli.py --help
+```
+
+> Note: The PyPI package is `cli-scry` (the name `scry` was
+> already taken by an unrelated package). The CLI command is simply
+> `scry`.
+
+## Why?
+Modern coding increasingly involves pasting code into LLM
+conversations, sharing project subsets with collaborators, or
+extracting specific modules for targeted code review. 
+The typical workflow (manually copying files, remembering paths, 
+stitching things together) is tedious and error-prone.
+
+`scry` simplifies this! Point to any Python project and it
+will automatically discover packages, modules, config files, and project 
+structure. Then export exactly the slice you need, in a format optimised for
+the recipient (be it human or machine).
+
+> **Due credit** -- this tool was heavily inspired by the excellent [repomix](https://github.com/yamadashy/repomix) tool. Where `repomix` is a feature-rich, 
+> comprehensive solution, `scry` is deliberately minimal: No dependencies, 
+> single-file, Python-native and designed for quick, selective 
+> exports as well as full-repo dumps.
+
+## Quick Start
+```bash
+# See what scry discovers in your project
+scry --list-modules
+
+# List every file (not just Python)
+scry --list-files
+
+# View core files + project overview in terminal
+scry
+
+# Export core files + project overview
+scry -o core.txt
+
+# Export a specific module
+scry --module models
+
+# Export only files you've changed since last commit
+scry --changed
+
+# Export everything as LLM-optimised XML
+scry --all --format xml -o codebase.xml
+# or
+scry --all -o codebase.xml    # Auto-detects extension 
+
+# Export specific files
+scry --files src/core.py config/defaults.yaml tests/test_core.py
+```
+
+## Features
+
+### Auto-Discovery
+`scry` understands Python project conventions out of the box:
+
+- Flat layout (`mypackage/` in project root)
+- Src layout (`src/mypackage/`)
+- Subpackages (automatically grouped as modules)
+- Special directories (`tests/`, `scripts/`, `examples/`, etc.)
+- Core project files (`pyproject.toml`, `README.md`, `requirements.txt`, etc.)
+
+You don't have to configure anything - just run it for your project!
+
+### Selective Export
+```bash
+scry --module models          # One module
+scry --module models training # Multiple modules
+scry --files src/config.yaml  # Specific files
+scry --changed                # Git-changed files only
+scry --all                    # Everything
+```
+
+### Secret Detection
+Before every export, scry scans for potential secrets (API keys,
+tokens, private keys, database credentials, and other sensitive
+patterns). Warnings are displayed before any output is written.
+
+**IMPORTANTLY**, `scry` does NOT automatically prevent secrets
+from appearing in the output. The output warnings require acknowledgement,
+but users MUST take care to ensure that sensitive info is not shared.
+
+An example warning:
+
+```
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+  POTENTIAL SECRETS DETECTED
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+  config/settings.py:
+    Line   42: Generic API Key — Generic API key assignment detected
+    Line   67: Database URL — Database connection string with credentials
+
+  Found 2 potential secret(s) across 1 file(s).
+  Review the above before sharing this export.
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+```
+
+Detected patterns include:
+- AWS access keys and secret keys
+- GitHub, GitLab, and Slack tokens
+- Stripe, SendGrid, and Heroku API keys
+- Private key blocks (RSA, EC, DSA, etc.)
+- Database connection strings with embedded credentials
+- Generic `password=`, `secret=`, `api_key=` assignments
+- JWT tokens
+- Sensitive filenames (`.env`, `.pem`, `.key`, `credentials.*`)
+
+Use --no-scan to skip if needed (but **use with caution!**).
+
+## Output Formats
+**Text** (default) - Markdown-style with fenced code blocks:
+```bash
+scry --module models -o export.txt
+```
+
+**XML** - Structured, `CDATA`-wrapped, and optimised for LLM parsing:
+```bash
+scry --all --format xml -o codebase.xml
+# or
+scry --all -o codebase.xml
+```
+
+The XML format uses `<file path="..." language="..." size="...">`
+elements with CDATA sections, which avoids the nested-backtick
+problems that can occur when LLMs parse markdown.
+
+## Full Project Listing
+Discover every file in your project, not just Python modules:
+```bash
+# List all files with sizes, grouped by directory
+scry --list-files
+
+# Filter to specific extensions
+scry --list-files --ext .yaml .yml .toml .json
+```
+
+The output includes a per-extension summary table, which is
+particularly helpful to spot any parts of your repo that are too chunky!
+
+```
+Extension         Count   Total Size
+───────────────   ──────   ────────────
+.py                  31       42.3 KB
+.yaml                 3        2.8 KB
+.toml                 1        1.3 KB
+───────────────   ──────   ────────────
+TOTAL                35       46.2 KB
+```
+
+## Optional Configuration
+`scry` is designed to work without any configuration. However,
+if you want fine-grained control, you can generate a config file:
+```bash
+scry --init-config
+```
+
+This creates `.scry.toml` in your project root, which is pre-populated
+with your project structure (as discovered by `scry`). You can use this
+to customise core files, ignore patterns, default modules, etc.
+
+```toml
+[scry]
+project_name = "myproject"
+core_files = ["pyproject.toml", "README.md"]
+default_module = "utils"
+tree_depth = 4
+
+ignore_dirs = [".git", "__pycache__", "venv", "node_modules"]
+ignore_patterns = ["*.egg-info", "*.pyc"]
+extensions = [".py"]
+```
+
+## Common workflows
+
+### Starting an LLM chat session
+```bash
+# Give the LLM your project overview and the module you're working on
+scry --module embeddings -o context.txt
+# Then paste or upload context.txt into your chat
+```
+
+### Debugging with an LLM
+```bash
+# Export only what you've changed (minimal, focused context)
+scry --changed
+```
+
+### Full codebase export for deep refactoring
+```bash
+# XML format for best LLM parsing
+scry --all --format xml -o codebase.xml
+```
+
+### Exploring an unfamiliar project
+```bash
+# What modules exist?
+scry --list-modules
+
+# What non-Python files are there?
+scry --list-files --ext .yaml .json .toml .cfg
+
+# Export the module you want to understand
+scry --module data_processing
+```
+
+## How does `scry` work?
+`scry` performs the following steps:
+1. **Detect project root** and load `.scry.toml` if present;
+2. **Discover source packages** by checking `src/` layout, then flat layout;
+3. **Map subpackages to module names** (each subdirectory with .py files becomes a selectable module);
+4. **Detect core files** (`pyproject.toml`, `README.md`, etc.);
+5. **Scan for secrets** before any export;
+6. **Format and output** in the requested format (currently supports txt and xml).
+
+## Requirements
+- Python 3.10+
+- **Zero dependencies** - `scry` is deliberately lightweight; we use only the standard Python library
+- Optional: `tomli` for `.scry.toml` support on Python <3.11

cli_scry-0.1.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+scry/__init__.py,sha256=guC3CIiNbLBFWRQzj1VbZkVxdGY1JpdVP3iDtAsrvGg,118
+scry/cli.py,sha256=nnQ8HIabkHY-XamrOX52b13gtlHxYz1JAyjHTSRL43Q,45530
+cli_scry-0.1.1.dist-info/METADATA,sha256=ffv9kXTrQY3e7TYz7R0s598vcbxTNow6qGK9pBqL-tQ,8851
+cli_scry-0.1.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+cli_scry-0.1.1.dist-info/entry_points.txt,sha256=qgeJk2-hrQZ7P0iK1WPxKJUIxkgmIHuwBJkNTw11ICE,39
+cli_scry-0.1.1.dist-info/licenses/LICENSE,sha256=VKnm5c3xFAFV-TRpRA-YtaTbQMNcz3VGWd4ZB5_SYlY,1088
+cli_scry-0.1.1.dist-info/RECORD,,

cli_scry-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

cli_scry-0.1.1.dist-info/entry_points.txt

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

cli_scry-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alon Douek
+
+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.

scry/__init__.py

@@ -0,0 +1,7 @@
+"""scry: Peer into any Python codebase."""
+
+__version__ = "0.1.0"
+
+from scry.cli import main
+
+__all__ = ["main"]