Metadata-Version: 2.2
Name: lib-explorer
Version: 1.1.0
Summary: A CLI tool for exploring Python modules and Robot Framework libraries
Author: Khaled LIMAM
License: MIT License
        
        Copyright (c) 2026 Khaled
        
        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: Homepage, https://github.com/khaledlim/rf-explorer
Project-URL: Source, https://github.com/khaledlim/rf-explorer
Project-URL: Issues, https://github.com/khaledlim/rf-explorer/issues
Keywords: robotframework,documentation,interactive,cli,python
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich>=13.0
Requires-Dist: InquirerPy>=0.3.4
Requires-Dist: robotframework>=6.0
Requires-Dist: Pygments>=2.15

# RF Explorer

![Python Version](https://img.shields.io/badge/python-3.9%2B-blue)
![License](https://img.shields.io/badge/license-MIT-green)
![Status](https://img.shields.io/badge/status-stable-brightgreen)

**RF Explorer** is an interactive command-line tool for exploring Python modules and Robot Framework libraries.  
It displays readable, syntax‑highlighted documentation directly in the terminal using **Rich**.

The tool can run in:
- **Interactive mode** (menu-driven text UI using Inquirer — runs in the terminal)
- **Direct mode** (CLI arguments)

---

## Features

- Explore **Python modules**: functions, classes, methods
- Explore **Robot Framework libraries**: keywords, arguments, examples
- Syntax‑highlighted documentation (Rich)
- Clean rendering of Robot Framework examples and pipe tables
- Colored ASCII banner

### CLI shortcuts:
  - `rf-explorer --help`
  - `rf-explorer python <module>`
  - `rf-explorer robot <library>`
  - `rf-explorer --search <keyword>`
  - `--all` to display all entries

### Fully modular architecture:

  - `core.py` → Interactive engine
  - `python_doc.py` → Python doc renderer
  - `robot_doc.py` → Robot doc renderer
  - `rf_doc_show.py` → Robot doc display
  - `scanner.py` → Module scanning
  - `utils.py` → Shared utilities
  - `cli.py` → Command‑line interface

---

##  Installation

```bash
pip install lib-explorer
