bry_py_mods

TestPyPI Page

Library of Modules and Scripts for My Own Personal Use

COMMAND LINE SCRIPTS

• $ ofs "extension", "extension", ...
  • Will list all items in the current directory with the listed extensions. If no arguments are provided, then an option will be given to show only unhidden items or all items.
  • Once items are selected, you can choose to open them all at once or one at a time.
• $ sfs "extension", "extension", ...
  • Will list all items in the current directory with the listed extensions. If no arguments are provided, then an option will be given to show only unhidden items or all items.
  • Once items are selected, they will be sorted into sub-directories based on their extension.
• $ convmd
  • Looks for markdown files in the current directory, and allows you to choose one or more.
  • Once items are selected, they will be converted to a pdf.

EXTERNAL DEPENDENCIES

• Getch
  • $ pip install getch
  • Python package to wait for a single key press input

MODULES

• File Manipulation
  • commands.py
    • Contains functions to be run as command scripts
  • directory.py
    • Contains parent class Directory, which obtains contents from the current working directory and forms them into a dictionary which can then be used to select one or more files.
  • get_keys.py
    • Contains function to wait for a single key press from user.
  • markdown_files.py
    • Child of Directory. Select multiple markdown files and manipulate them each individually. Allows user to convert md to pdf.
    • Dependencies
      • TeX Live
        • brew install texlive
        • System binaries to interact with the TeX document production system.
      • Cairo
        • brew install cairo
        • 2D graphics library written in C
      • Pandoc
        • brew install pandoc
        • File conversion software
      • Eisvogel Latex Template for Pandoc
        • Wandmalfarbe's Pandoc template to convert markdown files to pdf
        • Installation
        1. Extract the latest version of the template from the release page
        2. Move eisvogel.latex to your pandoc templates directory
           • Unix / Linux / MacOS : /Users/USERNAME/.local/share/pandoc/templates/
           • Windows Vista or later : C:\Users\USERNAME\AppData\Roaming\pandoc\templates
  • sorter.py
    • Child of Directory. Allows the user to sort items into sub-directories based on their extension.
  • items_to_open.py
    • Child of Directory. Allows the user to open items based on their extension.
• Timing
  • timers.py
    • Contains decorator function time_it() to measure execution / failure times