libjam 0.0.1__py3-none-any.whl

__init__.py

@@ -0,0 +1,6 @@
+from .captain import *
+from .typewriter import *
+from .drawer import *
+from .clipboard import *
+from .notebook import *
+from .flashcard import *

captain.py

@@ -0,0 +1,148 @@
+# Imports
+import sys, re, inspect
+from .typewriter import Typewriter
+from .clipboard import Clipboard
+typewriter = Typewriter()
+clipboard = Clipboard()
+
+# Processes command line arguments
+class Captain:
+
+  # Returns a generated a help page based on provided inputs
+  def generate_help(self, app: str, description: str, commands: dict, options: dict = None):
+    offset = 2; offset_string = ' ' * offset
+    commands_list = []
+    for command in commands:
+      command_desc = commands.get(command).get('description')
+      commands_list.append(f"{command}")
+      commands_list.append(f"- {command_desc}")
+    commands_list.append("help")
+    commands_list.append("- Prints this page")
+    commands_string = typewriter.list_to_columns(commands_list, 2, offset)
+    if options is not None:
+      options_list = []
+      for option in options:
+        option_desc = options.get(option).get('description')
+        long = ', --'.join(options.get(option).get('long'))
+        short = ', -'.join(options.get(option).get('short'))
+        options_list.append(f"-{short}, --{long}")
+        options_list.append(f"- {option_desc}")
+      options_string = typewriter.list_to_columns(options_list, 2, offset)
+
+    # Creating the help string
+    help_string = ''
+    # Adding description
+    help_string += f"{typewriter.bolden('Description:')}\n"
+    help_string += f"{offset_string}{description}\n"
+    # Adding synopsys
+    help_string += f"{typewriter.bolden('Synopsis:')}\n"
+    help_string += f"{offset_string}{app} [OPTIONS] [COMMAND]\n"
+    # Adding commands
+    help_string += f"{typewriter.bolden('Commands:')}\n"
+    help_string += commands_string.rstrip()
+    # Adding options
+    if options is not None:
+      help_string += f"\n{typewriter.bolden('Options:')}\n"
+      help_string += options_string.rstrip()
+
+    return help_string
+
+
+  # Interprets input arguments
+  def interpret(self, app: str, help: str, commands: dict, arguments: list, options: dict = None):
+    # Class vars
+    chosen_command = None
+    self.function = None
+    self.arbitrary_args = False
+    self.required_args = 0
+    self.command_args = []
+
+    # Creating option bools
+    if options is not None:
+      for option in options:
+        options[option]['enabled'] = False
+    # Parsing arguments
+    for argument in arguments:
+      if argument.startswith("-"):
+        if options is not None:
+          self.arg_found = False
+
+          # Long options
+          if argument.startswith("--"):
+            argument = argument.removeprefix("--")
+            for option in options:
+              strings = options.get(option).get('long')
+              if clipboard.is_string_in_list(strings, argument):
+                options[option]['enabled'] = True
+                self.arg_found = True
+            if self.arg_found is False:
+              print(f"Option '{argument}' unrecognized. Try {app} help")
+              sys.exit(-1)
+
+          # Short options
+          else:
+            argument = argument.removeprefix("-")
+            arguments = list(argument)
+            for argument in arguments:
+              command_found = False
+              for option in options:
+                strings = options.get(option).get('short')
+                if clipboard.is_string_in_list(strings, argument):
+                  options[option]['enabled'] = True
+                  command_found = True
+            if command_found is False:
+              print(f"Option '{argument}' unrecognized. Try {app} help")
+              sys.exit(-1)
+
+      # Commands
+      else:
+        if chosen_command is None:
+          if clipboard.is_string_in_list(commands, argument):
+            chosen_command = argument
+            command_function = commands.get(chosen_command).get('function')
+            command_args = inspect.signature(command_function)
+            command_args = command_args.format().replace('(', '').replace(')', '').replace(' ', '')
+            command_args = command_args.split(',')
+            if clipboard.is_string_in_list(command_args, '*args'):
+              command_args.remove('*args')
+              self.arbitrary_args = True
+            if command_args == ['']:
+              command_args = []
+            self.required_args = len(command_args)
+            continue
+          elif argument == 'help':
+            print(help)
+            sys.exit(0)
+        if chosen_command is None:
+          print(f"Command '{argument}' unrecognized. Try {app} help")
+          sys.exit(-1)
+
+        # Command arguments
+        else:
+          if self.arbitrary_args is False:
+            if self.required_args == 0:
+              print(f"Command '{chosen_command}' does not take arguments.")
+              sys.exit(-1)
+            elif len(self.command_args) >= self.required_args:
+              s = ''
+              if self.required_args > 1: s = 's'
+              print(f"Command '{chosen_command}' requires only {self.required_args} argument{s}.")
+              sys.exit(-1)
+          self.command_args.append(argument)
+    if self.arbitrary_args is False and self.required_args > len(self.command_args):
+      print(f"Command '{chosen_command}' requires {self.required_args} arguments.")
+      sys.exit(-1)
+
+    # Checking if command is specified
+    if chosen_command is None:
+        print(f"No command specified. Try {app} help")
+        sys.exit(0)
+
+    function = commands.get(chosen_command).get('function')
+    function_name = function.__name__
+    function_params = ''
+    for item in self.command_args:
+      function_params += f"'{item}', "
+    function = f"{function_name}({function_params})"
+
+    return {'function': function, 'options': options}

clipboard.py

@@ -0,0 +1,113 @@
+# Deals with lists and such
+class Clipboard:
+
+  # Checks if there is a string in a list
+  def is_string_in_list(self, input_list: list, input_string: str):
+    for item in input_list:
+      if item == input_string:
+        return True
+    return False
+
+  # Returns items present in both given lists
+  def get_duplicates(self, input_list1: list, input_list2: list):
+    result_list = []
+    for item in input_list1:
+      if self.is_string_in_list(input_list2, item):
+        result_list.append(item)
+    result_list = self.deduplicate(result_list)
+    return result_list
+
+  # Removes duplicates from a given list
+  def deduplicate(self, input_list: list):
+    result_list = list(set(input_list))
+    result_list.sort()
+    return result_list
+
+  def remove_duplicates(self, input_list1: list, input_list2: list):
+    result_list = []
+    duplicates = self.get_duplicates(input_list1, input_list2)
+    for item in input_list1:
+      if self.is_string_in_list(duplicates, item) is False:
+        result_list.append(item)
+    return result_list
+
+
+  # Returns input_list without any items from filter_list
+  def filter(self, input_list, filter_list):
+    result_list = []
+    for item in input_list:
+      if self.is_string_in_list(filter_list, item) is False:
+        result_list.append(item)
+    return result_list
+
+
+  # Returns a list of strings which contain substring
+  def match_substring(self, input_list: list, substring: str):
+    matching = []
+    for item in input_list:
+      if substring in item:
+        matching.append(item)
+    return matching
+
+
+  # Returns a list of strings which start with input_prefix
+  def match_prefix(self, input_list: list, input_prefix: str):
+    result_list = []
+    for item in input_list:
+      if item.startswith(input_prefix):
+        result_list.append(item)
+    return result_list
+
+  def remove_prefix(self, input_list: list, input_prefix: str):
+    result_list = []
+    for item in input_list:
+      result_list.append(item.removeprefix(input_prefix))
+    return result_list
+
+  # Returns a list of strings which ends with input_suffix
+  def match_suffix(self, input_list: list, input_suffix: str):
+    result_list = []
+    for item in input_list:
+      if item.endswith(input_suffix):
+        result_list.append(item)
+    return result_list
+
+  # Returns a list of strings which ends with input_suffix
+  def match_suffixes(self, input_list: list, input_suffixes: list):
+    result_list = []
+    for suffix in input_suffixes:
+      result_list += self.match_suffix(input_list, suffix)
+    return result_list
+
+
+  # Returns a list with lower-case strings
+  def lower(self, input_list: list):
+    result_list = []
+    for item in input_list:
+      result_list.append(item.lower())
+    return result_list
+
+  # Returns a list with upper-case strings
+  def upper(self, input_list: list):
+    result_list = []
+    for item in input_list:
+      result_list.append(item.upper())
+    return result_list
+
+
+  # Returns a list of strings containing given string, ignores case
+  def search(self, input_list: list, search_term: str):
+    result_list = []
+    search_term = search_term.lower()
+    for item in input_list:
+      if search_term in item.lower():
+        result_list.append(item)
+    return result_list
+
+  # Find & Replace for a list
+  def replace(self, input_list:list , oldstring: str, newstring: str):
+    result_list = []
+    for item in input_list:
+      item = item.replace(oldstring, newstring)
+      result_list.append(item)
+    return result_list

drawer.py

@@ -0,0 +1,359 @@
+# Imports
+import os, sys, shutil, send2trash, platform, tempfile, pathlib
+import zipfile, patoolib, rarfile
+from .typewriter import Typewriter
+from .clipboard import Clipboard
+typewriter = Typewriter()
+clipboard = Clipboard()
+
+# Internal functions
+joinpath = os.path.join
+def realpath(path: str or list):
+  if type(path) == str:
+    return os.path.normpath(path)
+  elif type(path) == list:
+    result_list = []
+    for item in path:
+      result_list.append(os.path.normpath(item))
+    return result_list
+
+def outpath(path: str or list):
+  if type(path) == str:
+    return path.replace(os.sep, '/')
+  elif type(path) == list:
+    result_list = []
+    for item in path:
+      result_list.append(item.replace(os.sep, '/'))
+    return result_list
+
+
+# Deals with files
+class Drawer:
+
+  # Returns True if give a path to folder
+  def is_folder(self, path: str):
+    path = realpath(path)
+    return os.path.isdir(path)
+
+  # Returns True if give a path to file
+  def is_file(self, path: str):
+    path = realpath(path)
+    return os.path.isfile(path)
+
+  def exists(self, path: str):
+    path = realpath(path)
+    is_file = self.is_folder(path)
+    is_folder = self.is_file(path)
+    if is_file or is_folder:
+      return True
+    else:
+      return False
+
+
+  # Returns the extension of a given file (a string)
+  def get_filetype(self, path: str):
+    path = realpath(path)
+    if self.is_folder(path):
+      return "folder"
+    elif self.is_file(path) is False:
+      return None
+    basename = self.basename(path)
+    filetype = os.path.splitext(basename)[1].removeprefix('.')
+    return filetype
+
+  # Returns a list of files and folders in a given folder
+  def get_all(self, path: str):
+    path = realpath(path)
+    relative_files = os.listdir(path)
+    absolute_files = []
+    for file in relative_files:
+      file = joinpath(path, file)
+      absolute_files.append(file)
+    return outpath(absolute_files)
+
+  # Returns a list of files in a given folder
+  def get_files(self, path: str):
+    path = realpath(path)
+    unfiltered_files = self.get_all(path)
+    files = []
+    for file in unfiltered_files:
+      if self.is_file:
+        files.append(file)
+    return outpath(files)
+
+  # Returns a list of folders in a given folder
+  def get_folders(self, path: str):
+    path = realpath(path)
+    folders = []
+    for item in self.get_all(path):
+      if self.is_folder(item):
+        folders.append(item)
+    return outpath(folders)
+
+  # Returns a list of all files in a given folder
+  def get_files_recursive(self, path: str):
+    path = realpath(path)
+    files = []
+    for folder in os.walk(path, topdown=True):
+      for file in folder[2]:
+        file = joinpath(folder[0], file)
+        files.append(file)
+    return outpath(files)
+
+  # Returns a list of all folders in a given folder
+  def get_folders_recursive(self, path: str):
+    path = realpath(path)
+    folders = []
+    for folder in os.walk(path, topdown=True):
+      for item in folder[1]:
+        item = joinpath(folder[0], item)
+        folders.append(item)
+    return outpath(folders)
+
+
+  # Renames a given file in a given path
+  def rename(self, folder: str, old_file: str, new_file: str):
+    folder = realpath(folder)
+    os.rename(f"{folder}/{old_file}", f"{folder}/{new_file}")
+    return 0
+
+
+  # Creates a new folder
+  def make_folder(self, path: str):
+    path = realpath(path)
+    path = os.mkdir(path)
+    return outpath(path)
+
+  # Creates a new file
+  def make_file(self, path: str):
+    path = realpath(path)
+    new = open(path, 'w')
+    new.close()
+    return outpath(path)
+
+
+  # Copies given file(s)/folder(s)
+  def copy(self, source: str, destination: str, overwrite=False):
+    source = realpath(source)
+    destination = realpath(destination)
+    if self.is_file(source):
+      shutil.copy(source, destination)
+    elif self.is_folder(source):
+      shutil.copytree(source, destination, dirs_exist_ok=overwrite)
+    return outpath(destination)
+
+
+  # Sends given file(s)/folder(s) to trash
+  def trash(self, path: str or list):
+    path = realpath(path)
+    if type(path) == str:
+      try:
+        send2trash.send2trash(path)
+      except FileNotFoundError:
+        print(f"File '{path}' wasn't found, skipping sending it to trash.")
+    elif type(path) == list:
+      for item in path:
+        try:
+          send2trash.send2trash(item)
+        except FileNotFoundError:
+          print(f"File '{path}' wasn't found, skipping sending it to trash.")
+    else:
+      return None
+    return outpath(path)
+
+
+  # Deletes a given file (using trash_file() instead is recommended)
+  def delete_file(self, path: str or list):
+    path = realpath(path)
+    if type(path) == str:
+      if self.is_file(path):
+        os.remove(path)
+    elif type(path) == list:
+      for item in path:
+        if self.is_file(path):
+          os.remove(item)
+    return outpath(path)
+
+  # Deletes a given folder (using trash() instead is recommended)
+  def delete_folder(self, path: str):
+    path = realpath(path)
+    try:
+      if self.is_folder(path):
+        shutil.rmtree(path)
+      else:
+        return None
+    except KeyboardInterrupt:
+      typewriter.print("Folder deletion cancelled.")
+      shutil.rmtree(path)
+      sys.exit(-1)
+    except PermissionError:
+      typewriter.print(f"Failed to delete folder '{path}', due to insufficient permissions.")
+      sys.exit(1)
+    return outpath(path)
+
+  # Returns the parent folder of given file/folder
+  def get_parent(self, path: str or list):
+    path = realpath(path)
+    if type(path) == str:
+      basename = self.basename(path)
+      parent = path.removesuffix(basename)
+      parent = parent.removesuffix(os.sep)
+      return outpath(parent)
+    elif type(path) == list:
+      result_list = []
+      for file in path:
+        basename = self.basename(file)
+        parent = file.removesuffix(basename)
+        parent = parent.removesuffix(os.sep)
+        result_list.append(parent)
+      return outpath(result_list)
+
+  # Returns depth of given file/folder
+  def get_depth(self, path: str):
+    path = realpath(path)
+    depth = path.split(sep=os.sep)
+    depth = len(depth)
+    return depth
+
+  def basename(self, path: str or list):
+    path = realpath(path)
+    if type(path) == str:
+      if self.is_folder(path):
+        path = os.path.basename(os.path.normpath(path))
+      else:
+        path = path.rsplit(os.sep,1)[-1]
+      return outpath(path)
+    elif type(path) == list:
+      return_list = []
+      for file in path:
+        if self.is_file(file):
+          file = os.path.basename(file)
+        elif self.is_folder(file):
+          file = os.path.basename(os.path.normpath(file))
+        return_list.append(file)
+      return outpath(return_list)
+
+  # Searches for string in list of basenames
+  def search_for_files(self, search_term: str, path: list):
+    path = realpath(path)
+    result_list = []
+    files = self.get_files_recursive(path)
+    for file in files:
+      basename = self.basename(file)
+      if search_term.lower() in basename.lower():
+        result_list.append(file)
+    return outpath(result_list)
+
+  def search_for_folder(self, search_term: str, path: str or list):
+    path = realpath(path)
+    result_list = []
+    if type(path) == str:
+      subfolders = self.get_folders(path)
+      for item in subfolders:
+        basename = self.basename(item)
+        if basename == search_term:
+          result_list.append(item)
+    elif type(path) == list:
+      for subfolder in path:
+        subfolders = self.get_folders(subfolder)
+        for item in subfolders:
+          basename = self.basename(item)
+          if basename == search_term:
+            result_list.append(item)
+    return outpath(result_list)
+
+  def search_for_folders(self, search_term: str, path: str or list):
+    path = realpath(path)
+    result_list = []
+    def search(search_term: str, path: str):
+      folders = self.get_folders_recursive(path)
+      for folder in folders:
+        basename = self.basename(folder)
+        if search_term.lower() in basename.lower():
+          result_list.append(folder)
+    if type(path) == str:
+      search(search_term, path)
+    elif type(path) == list:
+      for subfolder in path:
+        search(search_term, subfolder)
+    return outpath(result_list)
+
+  # Finds a folder with specified files
+  def find_folders_with_files(self, path: str, required_files: list):
+    path = realpath(path)
+    matches = []
+    for req in required_files:
+      matched_files = self.get_parent(self.search(req, path))
+      matched_files = Clipboard().deduplicate(matched_files)
+      if matched_files != []:
+        matches += matched_files
+    return outpath(matches)
+
+  # Checks if a given file is an archive
+  archive_types = ['zip', 'rar', '7z']
+  def is_archive(self, path: str):
+    path = realpath(path)
+    filetype = self.get_filetype(path)
+    if clipboard.is_string_in_list(self.archive_types, filetype):
+      return True
+    else:
+      return False
+
+  # Extracts a given archive
+  def extract_archive(self, archive: str, extract_location: str, progress_function=None):
+    archive = realpath(archive)
+    extract_location = realpath(extract_location)
+    archive_type = self.get_filetype(archive)
+    archive_basename = self.basename(archive).removesuffix(f".{archive_type}")
+    extract_location = joinpath(extract_location, archive_basename)
+    try:
+      if archive_type == 'zip': archive_function = zipfile.ZipFile
+      elif archive_type == 'rar': archive_function = rarfile.RarFile
+      elif archive_type == '7z':
+        try:
+          patoolib.extract_archive(archive, outdir=extract_location, verbosity=-1)
+          return extract_location
+        except PatoolError:
+          print("Please install the 'p7zip' package to process 7zip archives.")
+          return None
+      else:
+        return None
+      if archive_type == 'zip' or archive_type == 'rar':
+        archive_obj = archive_function(archive)
+        archived_files = archive_obj.namelist()
+        to_extract = len(archived_files)
+        extracted = 0
+        for archived_file in archived_files:
+          archive_obj.extract(archived_file, path=extract_location)
+          extracted += 1
+          if progress_function is not None:
+            progress_function(extracted, to_extract)
+    except KeyboardInterrupt:
+      typewriter.print("Archive extraction cancelled.")
+      self.delete_folder(extract_location)
+      exit()
+    return outpath(extract_location)
+
+  # Returns the home folder
+  def get_home(self):
+    home = str(pathlib.Path.home())
+    return outpath(home)
+
+  # Returns the temporary folder
+  def get_temp(self):
+    temp = str(tempfile.gettempdir())
+    return outpath(temp)
+
+  def get_file_size(self, path: str):
+    try:
+      size = 0
+      if self.is_file(path):
+        size += os.path.getsize(path)
+      elif self.is_folder(path):
+        subfiles = self.get_files_recursive(path)
+        for subfile in subfiles:
+          size += os.path.getsize(subfile)
+      return size
+    except KeyboardInterrupt:
+      typewriter.print('Program aborted while gathering size of files.')
+      sys.exit(1)

flashcard.py

@@ -0,0 +1,16 @@
+# Asks user for input
+class Flashcard:
+  def yn_prompt(self, question: str):
+    yes_choices = ['yes', 'y']
+    no_choices = ['no', 'n']
+    while True:
+      try:
+        user_input = input(f'{question} [y/n]: ')
+        answer = None
+        if user_input.lower() in yes_choices:
+          return True
+        elif user_input.lower() in no_choices:
+          return False
+      except KeyboardInterrupt:
+        print()
+        exit()

libjam-0.0.1.dist-info/METADATA

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: libjam
+Version: 0.0.1
+Summary: A library jam for Python.
+Project-URL: Homepage, https://github.com/philippkosarev/libjam
+Project-URL: Issues, https://github.com/philippkosarev/libjam/issues
+Author-email: Philipp Kosarev <philipp.kosarev@gmail.com>
+License-Expression: GPL-2.0
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.13.0
+Description-Content-Type: text/markdown
+
+# libjam
+A library jam for Python.
+
+## Modules
+libjam consists of of 6 modules:
+
+### Captain
+responsible for handling command-line arguments
+
+### Drawer
+responsible for file operations
+
+### Typewriter
+responsible for transforming and printing text
+
+### Clipboard
+responsible for working with lists
+
+### Notebook
+responsible for configuration
+
+### Flashcard
+responsible for getting user input from the command line
+
+## Example project
+```python
+#! /usr/bin/python
+
+# Imports
+import sys
+from libjam import Captain
+
+captain = Captain()
+
+class CLI:
+  def hello(self, text):
+    print(text)
+    if options.get('world').get('enabled'):
+      print('world!')
+
+cli = CLI()
+
+# Inputs/Commands/Options configuration
+app = "example"
+description = "An example app for the libjam library"
+# help = "" # If you wish to set your own help page text
+commands = {
+  'print':     {'function': cli.hello,
+  'description': 'Prints given string'},
+}
+options = {
+ 'world': {'long': ['world'], 'short': ['w'],
+ 'description': 'Appends \'world\' after printing given input'},
+}
+
+# Getting program arguments
+arguments = sys.argv
+# Removing script name from arguments
+arguments.remove(arguments[0])
+# Generating help
+help = captain.generate_help(app, description, commands, options)
+# Interpreting user input
+interpretation = captain.interpret(app, help, commands, arguments, options)
+# Getting parsed output
+function = interpretation.get('function')
+options = interpretation.get('options')
+# Executing function
+exec(f"cli.{function}")
+```

libjam-0.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+__init__.py,sha256=iLE2y9r0Sfe3oIeoFHKwFIyLL6d_KcLP7fINd7pPAlY,145
+captain.py,sha256=igx-ecKJBI_vBN-pW7KmSEnmYMIHQEb9tFzpy5qHmI8,5636
+clipboard.py,sha256=5HxlO8ztLJPlnSCq4PncGvY4JGc9C4J2uHcepjC6zmg,3496
+drawer.py,sha256=6LHAKzsBrBMQYoN1GkToa_zcgQFCx4PjRXsUT4vnkQ8,11069
+flashcard.py,sha256=ulV4KPC3BRWLxwkQ87vsY0aM38nYpzOjUOISxTIRVDg,437
+notebook.py,sha256=VQ7Slq_xAahACvIdSMEfo1K7_IpOC-agYezCtKS2OW0,2773
+typewriter.py,sha256=waKY1sDxGzI2ZT5dSzFmLGbaNTIpEM5Zhg_OlPFUAng,3730
+libjam-0.0.1.dist-info/METADATA,sha256=DEPY2SZQ8w6xwoHO-mboqab1mSgetPIm40A2EqL78TY,2001
+libjam-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+libjam-0.0.1.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+libjam-0.0.1.dist-info/RECORD,,

libjam-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

libjam-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

notebook.py

@@ -0,0 +1,84 @@
+# Imports
+import os, tomllib, configparser
+from .drawer import Drawer
+
+# Jam classes
+drawer = Drawer()
+
+# Deals with configs and reading/writing files
+class Notebook:
+
+  def __init__(self):
+    # Pre-requisites
+    script_folder = os.path.dirname(os.path.realpath(__file__))
+    script_folder = drawer.get_parent(script_folder)
+    self.config_template_file = f"{script_folder}/config.toml.in"
+
+  # Checking if config exists, and creating one if it does not
+  def check_config(self, config_file: str):
+    config_template = open(self.config_template_file, 'r').read()
+    config_folder = drawer.get_parent(config_file)
+    if drawer.is_folder(config_folder) is False:
+      drawer.make_folder(config_folder)
+    if drawer.is_file(config_file) is False:
+      drawer.make_file(config_file)
+      with open(config_file, 'w') as config:
+        config.write(config_template)
+      print(f"Created configuration file in '{config_folder}'.")
+    return config_file
+
+  # parsing a toml config
+  def read_toml(self, config_file: str):
+    config_file = os.path.normpath(config_file)
+    # Parsing config
+    data = open(config_file, 'r').read()
+    try:
+      data = tomllib.loads(data)
+      for category in data:
+        for item in data.get(category):
+          path = data.get(category).get(item)
+          if type(path) == str:
+            data[category][item] = path.replace(os.sep, '/')
+      return data
+    except:
+      print(f"Encountered error reading '{config_file}'")
+      print(f"Contents of '{config_file}':")
+      print(data)
+      return None
+
+  # Reads ini file and returns its contents in the form of a dict
+  def read_ini(self, ini_file: str, inline_comments=False):
+    if drawer.is_file(ini_file) is False:
+      return None
+    ini_file = os.path.normpath(ini_file)
+    if inline_comments is True:
+      parser = configparser.ConfigParser(inline_comment_prefixes=('#', ';'))
+    else:
+      parser = configparser.ConfigParser()
+    try:
+      parser.read(ini_file)
+    except configparser.ParsingError:
+      return None
+    sections = parser.sections()
+    data = {}
+    for section in sections:
+      keys = {}
+      for key in parser[section]:
+        value = parser[section][key]
+        keys[key] = value
+      data[section] = keys
+    return data
+
+  def write_ini(self, ini_file: str, contents: dict):
+    if drawer.is_file(ini_file) is False:
+      return None
+    ini_file = os.path.normpath(ini_file)
+    parser = configparser.ConfigParser()
+    for section in contents:
+      for var_name in contents.get(section):
+        value = contents.get(section).get(var_name)
+        if (section in parser) == False:
+          parser[section] = {}
+        parser[section][var_name] = value
+    with open(ini_file, 'w') as file:
+      parser.write(file)

typewriter.py

@@ -0,0 +1,119 @@
+# Imports
+import shutil
+
+# Responsible for formatting, modification and printing of strings
+class Typewriter:
+  def __init__(self):
+    # Shorthand vars
+    self.BOLD = '\033[1m'
+    self.NORMAL = '\033[0m'
+    self.CLEAR = '\x1b[2K'
+    self.CURSOR_UP = '\033[1A'
+
+  # Gets a string, makes it bold, returns the string
+  def bolden(self, text: str):
+    text = f'{self.BOLD}{text}{self.NORMAL}'
+    return text
+
+  # Clears a given number of lines in the terminal
+  # if given 0 the current line will be erased
+  def clear_lines(self, lines: int):
+    if lines == 0:
+      print("\r" + self.CLEAR, end='')
+      return
+    for line in range(lines):
+      print(self.CURSOR_UP + self.CLEAR, end='')
+
+  # Clears current line to print a new one.
+  # Usecase: after typewriter.print_status()
+  def print(self, text: str):
+    self.clear_lines(0)
+    print(text)
+
+  # Prints on the same line
+  def print_status(self, status: str):
+    self.clear_lines(0)
+    print(f" {status}", end='\r')
+
+  # Prints on the same line
+  def print_progress(self, status: str, current: int, total: int):
+    width = 25
+    progress_float= (current / total)
+    percent = int(round((progress_float* 100), 0))
+    percent_string = str(percent)
+    if percent < 100:
+      percent_string = ' ' + percent_string
+    if percent < 10:
+      percent_string = ' ' + percent_string
+    progress_width = int(progress_float * width)
+    progress_bar = '=' * progress_width + ' ' * (width - progress_width)
+    self.print_status(f"{percent_string}% [{progress_bar}] {status}: {current}/{total}")
+
+  # Given a list, it returns a string with the elements of the given list
+  # arranged in in columns
+  def list_to_columns(self, text_list: list, num_of_columns = None, offset = 2):
+    column_width = len(max(text_list, key=len))
+    # Automatically set num of columns if not specified otherwise
+    if num_of_columns is None:
+      terminal_width = shutil.get_terminal_size()[0] - 1
+      num_of_columns = int(terminal_width / (column_width + offset))
+      if num_of_columns < 1: num_of_columns = 1
+    # Creating a list of columns
+    columns = []
+    iteration = 0
+    for item in text_list:
+      current_column = iteration % num_of_columns
+      if len(columns) <= current_column:
+        columns.append([])
+      columns[current_column].append(item)
+      iteration += 1
+    # Equalising width of columns
+    current_column = 0
+    for column in columns:
+      column_width = 0
+      # Getting column width
+      for text in column:
+        if len(text) > column_width:
+          column_width = len(text)
+      # Adding spaces
+      current_text = 0
+      for text in column:
+        spaces = ' ' * ((column_width - len(text)) + 1)
+        columns[current_column][current_text] = text + spaces
+        current_text += 1
+      current_column += 1
+    # Adding offset
+    iteration = 0
+    for text in columns[0]:
+      columns[0][iteration] = ' ' * offset + text
+      iteration += 1
+    # Adding newlines
+    last_column = len(columns) - 1
+    iteration = 0
+    for text in columns[last_column]:
+      columns[last_column][iteration] = text + '\n'
+      iteration += 1
+    # Creating list of rows
+    rows = []
+    for row in range(len(columns[0])):
+      rows.append([])
+    current_row = 0
+    # print(columns)
+    # print()
+    for row in rows:
+      current_column = 0
+      for column in columns:
+        try:
+          text = columns[current_column][current_row]
+        except IndexError:
+          continue
+        rows[current_row].append(text)
+        current_column += 1
+      current_row += 1
+    # Adding rows' text to output
+    output = ''
+    for row in rows:
+      for text in row:
+        output += text
+    # Returning string
+    return output