pegasus-client

Command-line and web tool with modular interface.


Keywords
command-line, web, tool
License
MIT
Install
pip install pegasus-client==0.17

Documentation


Pegasus

A command line tool for automating various tasks.

Installation

Use the package manager pip to install Pegasus.

pip3 install -r requirements.txt

Usage

Web

Run the pegasus_web.py file, this will start a flask server and allow you to access it through the displayed location (http://127.0.0.1:5000/) in a browser.

python3 pegasus_web.py

Terminal

Run the pegasus_terminal.py file, this will load up the terminal version of Pegasus.

python3 pegasus_terminal.py

command: 

SQL

Use Pegasus to save and run queries more easily. Configure your connections, queries, and commands (collection of queries) by going to /sqlsetup, or using the SQL Setup option in the settings drop-down.

Create connections to your commonly used databases for MySQL, SQL Server and Azure DBs. Save your queries, then group them together with a command. Include parameters in your queries with %p.

Default Commands

  • help (loads list of all available commands
  • format (format json, sql, xml, and sql lists from your clipboard)
  • sql (save and run your common sql queries)
  • update (check and update to the latest version of Pegasus)

Adding modules

Follow the below structure for any new modules. Save this into the modules folder and import this at the top of the main.py file with the format from modules.file_name import class_name

class example:
    """Tagline here for description of the module. Used when running the default 'help' command."""

    def __init__(self):
        pass

    def __run__(self, params=None):

        """actions performed here"""

        return [] # return list of results to be returned to the user

    def sub_commands(self):
        """Provide a list of sub-commands that can be called directly without the module code."""

        return []