Metadata-Version: 2.1
Name: pegasus-client
Version: 0.6
Summary: Command-line and web tool with modular interface.
Home-page: https://github.com/euanacampbell/pegasus
Download-URL: https://github.com/euanacampbell/pegasus/archive/refs/heads/master.tar.gz
Author: Euan Campbell
Author-email: dev@euan.app
License: MIT
Keywords: command-line,web,tool
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
License-File: LICENSE

<a href="url"><img src="/static/img/pegasus_icon.png" align="left" height="48" width="48" ></a>
<br>
# Pegasus

A command line tool for automating various tasks.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install Pegasus.

```bash
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.

```bash
python3 pegasus_web.py
```


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

```bash
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`

```python
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 []
```




