Metadata-Version: 2.4
Name: lib-explorer
Version: 1.1.1
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
Dynamic: license-file

# 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)

PyPI: https://pypi.org/project/lib-explorer/  
GitHub: https://github.com/khaledlim/rf-explorer

RF Explorer is an interactive command-line tool to explore Python modules and Robot Framework libraries.
It renders readable, syntax-highlighted documentation directly in the terminal using Rich.

## Highlights

- Interactive terminal mode (menu-driven UI with InquirerPy)
- Direct CLI mode for quick commands
- Python module exploration: functions, classes, methods, and docstrings
- Robot Framework library exploration: keywords, arguments, documentation, and examples
- Installed package listing with filtering
- Environment scan (Python, Robot Framework, or full)
- Global Robot keyword search

## Installation

```bash
pip install lib-explorer
```

## Quick Start

```bash
# Interactive mode
rf-explorer

# Help and version
rf-explorer --help
rf-explorer --version
```

## CLI Usage

```text
rf-explorer
rf-explorer --help
rf-explorer --version

rf-explorer python <module> [regex|--all]
rf-explorer robot <library> [regex|--all]

rf-explorer --list
rf-explorer --list --filter <text>

rf-explorer --scan robot
rf-explorer --scan python
rf-explorer --scan --all

rf-explorer --search <keyword-or-regex>
```

## Examples

### Explore a Python module

```bash
rf-explorer python requests
rf-explorer python requests get
rf-explorer python requests --all
```

### Explore a Robot Framework library

```bash
rf-explorer robot JSONLibrary
rf-explorer robot JSONLibrary Convert
rf-explorer robot JSONLibrary --all
```

### List installed packages

```bash
rf-explorer --list
rf-explorer --list --filter py
```

### Scan environment

```bash
rf-explorer --scan robot
rf-explorer --scan python
rf-explorer --scan --all
```

### Search Robot keywords globally

```bash
rf-explorer --search browser
```

## Notes

- Requires Python 3.9+
- Works best in a terminal that supports colors

## License

MIT (see LICENSE)
