Metadata-Version: 2.4
Name: repoxray
Version: 0.1.0
Summary: X-ray any git repository
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# ☢️ RepoXray

**Instantly understand the DNA of any codebase.**

Jumping into a massive, unfamiliar repository can be overwhelming. `RepoXray` is a lightning-fast static analysis CLI tool that scans a project's directory structure, reads manifest files, and analyzes import graphs to give you an instant architectural summary of the codebase.

Whether you are onboarding to a new company project, exploring an open-source library, or just need to know where a repository "starts," RepoXray gives you the map.

---

## ✨ Features

- **🚀 Zero-Friction Scanning:** Point it at a local directory, a full Git URL, or just use the GitHub shorthand (`username/repo`).
- **🧠 Intelligent Heuristics:** It doesn't just guess; it analyzes file sizes, directory depth, and inbound import frequencies to rank the most "important" files.
- **🏗️ Architecture Detection:** Automatically identifies patterns like Monorepos, MVC, SPA, Event-Driven, and API-to-Database pipelines.
- **🤖 Deep Framework Knowledge:** Recognizes dozens of frameworks across Python, JavaScript, TypeScript, Go, Rust, Ruby, and more—including deep learning stacks like PyTorch, TensorFlow, and Hugging Face.
- **⚡ Ephemeral Cloning:** When scanning a remote repo, it performs a shallow clone into a temporary directory, analyzes it, and cleans up after itself automatically.
- **🔌 JSON Output:** Native support for `--json` output, making it perfect for CI/CD pipelines or automated repository auditing.

---

## 💻 Example Output

```bash
$ repoxray huggingface/transformers

Scanning [https://github.com/huggingface/transformers](https://github.com/huggingface/transformers) …

Project Summary

  Language:      Python
  Framework:     pytest, PyTorch, Hugging Face
  Entry point:   Unknown
  Architecture:
    library / package

  Important files:
    • src\transformers\cli\transformers.py
    • src\transformers\data\processors\utils.py
    • src\transformers\generation\utils.py
    • src\transformers\pipelines\base.py
    • src\transformers\quantizers\base.py

  Scan completed in 86.40 seconds
