Skip to main content

A CLI tool for exploring Python modules and Robot Framework libraries

Project description

RF Explorer

Python Version License Status

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

pip install lib-explorer

Quick Start

# Interactive mode
rf-explorer

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

CLI Usage

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

rf-explorer python requests
rf-explorer python requests get
rf-explorer python requests --all

Explore a Robot Framework library

rf-explorer robot JSONLibrary
rf-explorer robot JSONLibrary Convert
rf-explorer robot JSONLibrary --all

List installed packages

rf-explorer --list
rf-explorer --list --filter py

Scan environment

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

Search Robot keywords globally

rf-explorer --search browser

Notes

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

License

MIT (see LICENSE)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lib_explorer-1.1.1.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lib_explorer-1.1.1-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file lib_explorer-1.1.1.tar.gz.

File metadata

  • Download URL: lib_explorer-1.1.1.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for lib_explorer-1.1.1.tar.gz
Algorithm Hash digest
SHA256 dffa30c9472879f13965356b86105dca1aa4e517e9beab7bc841ef17e4f7dac1
MD5 ff429f3a4dd64b3fc5a8254b82ba86db
BLAKE2b-256 57a777f3134fd994a158f90fb9cb9451e97b8a95750e259affed7e1b83264b54

See more details on using hashes here.

File details

Details for the file lib_explorer-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: lib_explorer-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for lib_explorer-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0b164d6102d739a67da5b4840621cb297850f1813012c3a4e9db82a645c1b514
MD5 89a41431833bf01d82ce8aa068ca3290
BLAKE2b-256 f3f52420f9309a52f79a58006987813244ff33a35aca4253dc99721a915f68cf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page