Skip to main content

A CLI tool for exploring Python modules and Robot Framework libraries

Project description

RF Explorer

Python Version License Status

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

pip install lib-explorer

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.0.tar.gz (14.4 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.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lib_explorer-1.1.0.tar.gz
  • Upload date:
  • Size: 14.4 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.0.tar.gz
Algorithm Hash digest
SHA256 6776273641193a6f637b680743d51f20366871c570eeb17411d31c9860f3df7e
MD5 73308837a59d65c9cebe495fe1fbbf36
BLAKE2b-256 bd1a9a83305db900c6284129a182f4b71def75c300407125760a74f9dc8ac98d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lib_explorer-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be295cf84ccdfd2bf447ae5a7c263217068052b34765a799f632d35b83483fc0
MD5 bfdc704ca4e338addeabe36906346173
BLAKE2b-256 03ba725025205d79fc8ee8745c2828da592648245e8997520463096c8b0a846c

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