Metadata-Version: 2.4
Name: pyintrospect
Version: 0.1.0
Summary: Clean Python introspection wrapper
Author-email: Hoàng Long <hoanglongdeptrai392@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Hoang Long
        
        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.
        
Keywords: inspect,introspection,reflection,debugging,analysis,introspect
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# PyIntrospect

**PyIntrospect** is a lightweight Python introspection wrapper that provides a clean and structured way to analyze modules at runtime.

It is built on top of Python’s built-in `inspect` module and helps you extract:

- Submodules
- Variables
- Constants
- Functions (with signatures)
- Classes (with `__init__` signatures)
- Module source code
- Module file path

---

## Installation

```bash
pip install pyintrospect
```

---

## Quick Start

```python
import pyintrospect
import os

r = pyintrospect.Reflect(os)
```

---

## Core Concept

PyIntrospect is designed to make Python introspection easier, cleaner, and more readable.

Instead of manually using `inspect`, you get structured and ready-to-use outputs.

---

## API Reference

### Reflect(module, HideDunder=True, pretty=True)

| Parameter   | Description |
|-------------|------------|
| module      | Python module to inspect |
| HideDunder  | If True, hides `_private` and `__dunder__` members |
| pretty      | If True, prints results automatically |

---

## Methods

### submodules()
```python
r.submodules()
```

### variables()
```python
r.variables()
```

### constants()
```python
r.constants()
```

### functions()
```python
r.functions()
```

### classes()
```python
r.classes()
```

### source()
```python
r.source()
```

### path()
```python
r.path()
```

### all()
```python
r.all()
```

---

## Notes

- Built-in modules may not expose source code
- Some functions may not have a signature
- `HideDunder=True` filters private members

---

## Philosophy

> Make Python introspection readable, structured, and developer-friendly.

---

## License

MIT License

Copyright (c) 2026 Hoang Long
