Metadata-Version: 2.1
Name: flauncher
Version: 1.4.0
Summary: Universal CLI file launcher
Home-page: https://github.com/yoarch/flauncher
Author: yoarch
Author-email: yo.managements@gmail.com
License: UNKNOWN
Description: # Flauncher
        Universal CLI file launcher
        
        Launch any file in terminal with one unique command. flauncher works as a command router and launches the input files with the according application/program regarding your settings preferences. Can also be imported in your own python codes.
        
        Then, flauncher can deal with any file type such as **audio, image, libreoffice-writer (odt), libreoffice-calc (ods), pdf, rar, tar, tar.gz, tar.xz, tar.bz2, text, tgz, zip, video, etc.** files.
        
        # Installation
        ```sh
        With pip:
        sudo pip3 install flauncher
        
        With yay:
        yay -a flauncher
        
        With yaourt:
        yaourt -a flauncher
        ```
        
        # Compatibility
        python >= 3
        
        
        # Usage
        <pre>
        <b>flauncher</b> [<b>FILE_PATH_01 FILE_PATH_02 ...</b>]
        <b>options:</b>
        <!-- -->         <b>-h, --help</b>        show this help message and exit
        <!-- -->         <b>-m [mode]</b>         select another mode than the default open one to open another conf file than open.json
        </pre>
        
        # Configuration
        The settings defining the command to be run for any extension type are located in the *~/.config/flauncher/open.json* json file.
        
        If this file doesn't exist, copy the default one located in *usr/lib/flauncher/open.json* and configure it as you wish.
        
        ```sh
        {
          "audio": {
            "type": "playlist",
            "exts": ["mp3", "wav", "m4a", "aac", "mp1", "mp2", "flac", "aa", "aax", "act", "aiff", "amr", "ape", "au", "awb", "dct", "dss", "dvf", "gsm", "iklax", "ivs", "m4b", "m4p", "mmf", "mpc", "msv", "nmf", "nsf", "oga", "mogg", "opus", "ra", "raw", "sin", "tta", "vox", "wma", "wv", "8svx"],
            "app": "mpv",
            "args": "--fs-screen=all -fs --loop-playlist --script-opts=osc-hidetimeout=6000 --player-operation-mode=pseudo-gui"
          },
          "image_bitmap": {
            "type": "playlist",
            "exts": ["jpg", "jpeg", "png", "tif", "gif", "bmp", "pjpeg", "jfif", "exif", "tiff", "png", "ppm", "pgm", "pbm", "pnm", "webp", "hdr", "heif", "bat", "bpg"],
            "app": "sxiv",
            "args": "-bf"
          },
          "image_vectorial": {
            "type": "lonely",
            "exts": ["svg"],
            "app": "inkscape",
            "args": null
          },
          ...
          ...
        }
        ```
        
        By default any audio and video files are launched with **mpv**, any image with **sxiv**, any pdf with the **brave** browser, any text with the **atom** editor, etc. But feel free to set your preferred application.
        
        # Examples
        For **help**:<br/>
        ```sh
        flauncher -h
        or
        flauncher --help
        ```
        
        Launch a **pdf**, a **zip**, a **tar.gz** and a **mp3**:<br/>
        ```sh
        flauncher titi.pdf toto/tutu.zip toto/tutu.tar.gz toto/tata/tutu.mp3
        ```
        
        
        # Custom mode
        Define others modes corresponding to others conf files with the **-m** parameter.
        When specifying the **-m** parameter, you have to precise the **mode** name just after it corresponding to the *~/.config/flauncher/**mode**.json* conf file.
        **-m edit** will use the *~/.config/flauncher/edit.json* conf file rather than the default launch.json one.
        
        Then, you can have different launch mode corresponding to any kind of file.
        
        
        # Suggestions
        Use the **o** command to open any file:<br/>
        ```sh
        alias o='flauncher'
        ```
        
        And the **e** command to edit any file:<br/>
        ```sh
        alias e='flauncher -m edit'
        ```
        
        
        # Python import
        You can import the flauncher package in your own codes and then call the get_cmds method with the file paths and the mode you want to use.
        
        ```
        from flauncher import get_cmds
        cmds = get_cmds(f_paths, mode)
        ```
        
        It will return a list of clean cmds, every cmd being a dictionary with the "app", the "args" and the "su" attributes.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
