Skip to main content

An interactive shell library

Project description

Plastron

An interactive shell application Learn More Build interactive, menu driven, shell programs using Python 3+

Getting started

The easiest way to get started with Plastron is to install the library from pip.

  1. Create a file: shell.py
  2. pip install plastron
  3. from plastron import Plastron

Here is sample code for a shell program with one menu to check disk space on the machine.

# An import we need
import os

# Import plastron module
from plastron import Plastron

# A useful function
def useful_disk_free_check():
    os.system("df -h")

# Inatalize the shell
my_shell = Plastron("Kavun", "PLASTRON", "A personal shell")

# Create a menu for this shell
metrics_menu = my_shell.menu("metrics","Metrics")

# Create an item for this menu to run the function
disk_item = my_shell.item("disk", "Disk check")

# Add the useful function to the item's procedure
disk_item.add_procedure(useful_disk_free_check)

# Add the item to the menu
metrics_menu.add_item(disk_item)

# Add the new menu to the main menu
my_shell.menus['main'].add_item(metrics_menu)

# Launch the shell
my_shell.shell()

Now run python shell.py you should see something like this:

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

plastron-1.0.5.tar.gz (7.6 kB view hashes)

Uploaded Source

Built Distribution

plastron-1.0.5-py3-none-any.whl (11.5 kB view hashes)

Uploaded Python 3

Supported by

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