Metadata-Version: 2.4
Name: gnost
Version: 0.2.0
Summary: GNOST — Codebase Knowledge
Author-email: Mohd Zain <zainmohd1998@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Mohd Zain
        
        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.
        
Project-URL: Documentation, https://gnost.readthedocs.io
Project-URL: Source, https://github.com/mohdzain98/gnost
Project-URL: Issues, https://github.com/mohdzain98/gnost/issues
Project-URL: Changelog, https://github.com/mohdzain98/gnost/blob/main/CHANGELOG.md
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich
Requires-Dist: tqdm
Dynamic: license-file

# GNOST — Codebase Knowledge
![PyPI](https://img.shields.io/pypi/v/gnost)
![Python](https://img.shields.io/pypi/pyversions/gnost)
![License](https://img.shields.io/pypi/l/gnost)

GNOST helps developers understand unfamiliar codebases by automatically identifying entry points, execution flow, and core logic. It is designed for first-day onboarding, not just code statistics.

## Why GNOST?
- Quickly build a mental model of a new codebase
- See how execution flows without reading everything
- Generate onboarding docs and Mermaid diagrams with one command

## What GNOST Does
- Detects **where execution starts**
- Infers **high-level execution flow**
- Identifies **hotspot files** (most important code)
- Generates **onboarding documentation**
- Produces **Mermaid flow diagrams**
- Works across multiple languages

## Getting Started
Install:

```bash
pip install gnost
```

Run the onboarding scan:

```bash
gnost onboard .
```

Minimal usage examples:

```bash
gnost summary .
gnost stats .
```

Supported languages: Python, JavaScript, TypeScript, Java.

## Project Links
### Full Documentation and Usage:
[![Docs](https://img.shields.io/readthedocs/gnost?label=docs)](https://gnost.readthedocs.io)

### Changelog:
[![Changelog](https://img.shields.io/badge/changelog-CHANGELOG.md-blue)](./CHANGELOG.md)

## Philosophy
GNOST focuses on fast, heuristic-based static analysis to help developers onboard quickly. It prioritizes clarity and actionable summaries over exhaustive analysis.

<!-- GNOST:ONBOARDING:START -->

## Onboarding
This repository includes an auto-generated onboarding guide.

[![Onboarding](https://img.shields.io/badge/onboarding-ONBOARD.md-cyan)](./ONBOARD.md)

Generated by <a href="https://gnost.readthedocs.io">GNOST</a> to help understand the codebase.

<!-- GNOST:ONBOARDING:END -->


## License
MIT License
