donfanning / pyterm Goto Github PK

#PyTerm

PyTerm is a Python-based terminal client for Linux that highlights the available commands of your computer.

#Installation

To install, all you need to do is, run the following commands in your terminal:

$ git clone https://github.com/jeffersonmourak/pyTerm.git
$ cd pyTerm/

and you are all set. Now, just go to the Usage topic to see how to use this. :)

#Usage

This project is just beginning, so you can run the very basic terminal commands and those aliases.

To start PyTerm, you need to run the following in your terminal.

$ python terminal.py

To exit, you can use ctrl+C shortcut.

#plugins

A plugin is a Python file, placed inside plugin/ directory, this file must have a class with the name of the file.

Example: If the file is plugin.py, it must have a class plugin defined as follows:

class plugin(object):

and this class must have a method called __pytermconfig__.

Without arguments, this method must return a dictionary, with those indexes,

• "command": is the command that will be run in the terminal
• "callback": is a function file, that will be called when the command is executed

The callback function must have *args and **kwargs as arguments too, these will allow getting the configurations of the terminal.

Jefferson Moura (jeffersonmourak).

Jonhnatha Trigueiro (joepreludian).