DigitalSwissArmyKnife

(Pre-release documentation, still incomplete)

A digital multitool that uses a customized Python interpreter as a base

Note: This README file is incomplete and DSAK is still under heavy development so nothing will be stable or accurate.

To add dsaklib just make a venv and add it to the lib folder, then run the main.py file

About
- Information
- Features
  - Interpreter
  - dsaklib
    - cmdpkg
    - shortcode
      - Features
Installation

About

About section

Information

Digital Swiss Army Knife (or DSAK for short), is a digital command line utility written in Python that runs on a customized interpreter through a modified version of the code module.

Features

dsaklib

dsaklib is the custom library that contains the modules used for DSAK

cmdpkg

cmdpkg is a system of module-based command "packages" that you can import into the DSAK (or any other Python interpreter or script). By default, the main.py script will import cmdpkg.base by default like this:

from dsaklib.cmdpkg.base import * #Imports base commands

There are also a few other utilities that come packaged by default, you can import them this way at the moment:

from dsaklib.cmdpkg.misc import * #Imports a small set of misc commands

Base Commands

Here are a handful of base commands:

Command	Description	Function it calls
`cd()`	Change directory	`os.chdir()`
`ls()`	Shows the files of your current directory	`os.system('ls')`
`clr()`	Clears the screen	`os.system('clear')`
`cls()`	Same as `clr()`	`clr()`
`clear()`	Same as `clr()`	`clr()`
`editor()`	Opens the default editor	`os.system('$EDITOR')`
`sudo_editor()`	Opens default editor as sudo	`os.system('sudo $EDITOR')`

(The function these call isn't exact to the source code, these also aren't final)

Future Module Ideas

A MCPI command set (simplified commands from the mcpi module)
Something that handles compression using tar
Encrypt files using glew

Adding Custom Command Sets

(incomplete)

Here is an example template command set module:

'''INFO
Name:        template
Description: A template command set
Author(s):   Robert Furr
Year:        2021

This and all other command sets are Licensed under the GNU General Public License. For more info, see the LICENSE file included with DSAK.
'''
def hello():
  # Add an description to every definition
  '''Prints hello world (example command)'''
  print('Hello, world!')

shortcode

Utility module that is fine tuned to make the code for DSAK more simple.

Features

(coming soon)

Extra

If you encounter any bugs, please open an issue :)

Installation

(coming soon)

gitter-badger / digitalswissarmyknife Goto Github PK