Metadata-Version: 2.1
Name: nf
Version: 1.2.0
Summary: Simple command line tool to make notification after target program finished work
Home-page: https://github.com/NIC-MichalLabedzki/nf
Author: Michał Łabędzki
Author-email: michal.tomasz.labedzki@gmail.com
License: UNKNOWN
Description: ==============
        nf
        ==============
        
        .. |NF_VERSION| replace:: v1.2.0
        
        .. image:: https://travis-ci.org/NIC-MichalLabedzki/nf.svg?branch=master
           :target: https://travis-ci.org/NIC-MichalLabedzki/nf
        
        .. image:: https://badge.fury.io/py/nf.svg
           :target: https://badge.fury.io/py/nf
        
        .. image:: https://img.shields.io/pypi/v/nf
        
        .. image:: https://img.shields.io/pypi/pyversions/nf.svg
           :target: https://pypi.python.org/pypi/nf
        
        .. image:: https://img.shields.io/pypi/implementation/nf
        
        .. image:: https://img.shields.io/github/repo-size/NIC-MichalLabedzki/nf
        
        .. image:: https://img.shields.io/github/languages/code-size/NIC-MichalLabedzki/nf
        
        .. image:: https://img.shields.io/pypi/l/nf
        
        .. image:: https://img.shields.io/coveralls/github/NIC-MichalLabedzki/nf
        
        .. image:: https://img.shields.io/github/commits-since/NIC-MichalLabedzki/nf/v1.2.0
        
        IN SHORT
        --------
        
        ``nf`` is a tool to make notification for user that its command finish work. For example "make" program that takes long time to finish.
        
        SPDX-License-Identifier: 0BSD
        
        Project name: nf
        License: 0BSD / Free Public License 1.0.0
        More information about license: https://opensource.org/licenses/0BSD
        
        CHANGELOG
        ---------
        
        From 1.1.1:
            1. Add ssh/paramiko backends to open backward ssh channel to provide notification on the local machine (based on $SSH_CLIENT environment variable)
            2. Add multiplatform notification backends: plyer, plyer_toast (for Android but who knows)
            3. Use parent process as shell if it is a shell instead of system shell
        
        SCREENSHOTS
        -----------
        
        1. Screenshot from KDE:
        
        .. image::  https://raw.githubusercontent.com/NIC-MichalLabedzki/nf/v1.2.0/images/screenshot_1_kde.png
           :target: https://raw.githubusercontent.com/NIC-MichalLabedzki/nf/v1.2.0/images/screenshot_1_kde.png
           :alt: Screenshot from KDE
           :width: 200
        
        2. Screenshot from KDE:
        
        .. image::  https://raw.githubusercontent.com/NIC-MichalLabedzki/nf/v1.2.0/images/screenshot_2_kde.png
           :target: https://raw.githubusercontent.com/NIC-MichalLabedzki/nf/v1.2.0/images/screenshot_2_kde.png
           :alt: Screenshot from KDE
           :width: 200
        
        3. Screenshot from KDE:
        
        .. image::  https://raw.githubusercontent.com/NIC-MichalLabedzki/nf/v1.2.0/images/screenshot_3_kde.png
           :target: https://raw.githubusercontent.com/NIC-MichalLabedzki/nf/v1.2.0/images/screenshot_3_kde.png
           :alt: Screenshot from KDE
           :width: 200
        
        4. Screenshot from Android:
        
        .. image::  https://raw.githubusercontent.com/NIC-MichalLabedzki/nf/v1.2.0/images/screenshot_4_android.png
           :target: https://raw.githubusercontent.com/NIC-MichalLabedzki/nf/v1.2.0/images/screenshot_4_android.png
           :alt: Screenshot from Android
           :width: 200
        
        NON-INSTALL
        -----------
        
        .. code-block:: bash
        
            git clone git@github.com:NIC-MichalLabedzki/nf.git
        
        You can run it from sources without any dependancies* (python and some modules delivered with it)
        
        .. code-block:: bash
        
            python ./nf.py
        
        See:
        
        .. code-block:: bash
        
            python ./nf.py --help
        
        See CLI section for more details.
        
        
        INSTALLATION
        ------------
        
        .. code-block:: bash
        
            pip install nf
        
        or
        
        .. code-block:: bash
        
            pip install -e git@github.com:NIC-MichalLabedzki/nf.git
        
        or
        
        .. code-block:: bash
        
            pip install -e https://github.com/NIC-MichalLabedzki/nf.git
        
        or
        
        .. code-block:: bash
        
            git clone git@github.com:NIC-MichalLabedzki/nf.git
            cd nf
            python setup.py # or pip install -e .
        
        
        INTERFACE
        ---------
        
        There are one kind of interfaces: ``CLI``.
        
        If you think there is a need to have ``lib``/``module`` to please let me know why.
        Maybe there is a reason.
        
        CLI
        ~~~
        
        CLI is Command Line Interface. So you have tool called: nf
        
        .. code-block:: bash
        
            $ python nf.py --help
            usage: nf.py [-h] [-l LABEL] [-p] [-n] cmd ...
        
            Simple command line tool to make notification after target program finished work
        
            positional arguments:
            cmd
            args
        
            optional arguments:
            -h, --help            show this help message and exit
            -l LABEL, --label LABEL
                                    Add humn readable text to custom job identification
            -p, --print           Print notification text in stdout too
            -n, --no-notify       Do not do annoying notifications
            -s, --save            Save/append command and stat to .nf file
            -b {paramiko, ssh, dbus,notify-send,termux-notification,win10toast,plyer,plyer_toast,stdout}, --backend {paramiko, ssh, dbus,notify-send,termux-notification,win10toast,plyer,plyer_toast,stdout}
                                  Notification backend
            -d, --debug           More print debugging
        
            Examples:
            nf make
            nf ls
            nf ls not_exist_file
            nf sleep 2
            nf -l sleeping sleep 2
            nf -l `tty` ls
            nf "ls | grep .py"
        
            "/home/nf/src/nf$ nf.py -p ls
            LICENSE  nf.py  pytest.ini  README  README.dev  requirements-dev.txt  setup.cfg  setup.py  tox.ini
            -----------------------------------------------------------
            "/home/nf/src/nf$ ls" finished work.
        
            Start time:   17:32.50
            End time:     17:32.50
            Elapsed time: 00:00.00
            -----------------------------------------------------------
        
        LIMITATIONS
        -----------
        1. Work with Jython: it does not have dbus module, fallback to command line.
        2. Observed in KDE: notification with the same body (text) can be dropped. To avoid that I add timestamp text to make nofitications unique.
        
        FEATURES
        --------
        1. Support Android notification by termux-notifications (of course by `termux`)
        2. Support dbus by python module or fallback to `notify-send` (part of `libnotify` 0.7.7 or 0.7.8)
        3. Option to print notification on stdout.
        4. Option to save full command line and stat to file into working directory.
        5. Support whole python implementations/versions (at least not crash and print on stdout)
        6. Case SSH: If you are over SSH send notification over backward-SSH connection to your native system (force password)
        7. Supported notification backends: paramiko (ssh), ssh, dbus, notify-send, termux-notification (Android), win10toast (Windows),plyer, plyer_toast, stdout
        
        TODO
        ----
        1. Konsole terminal (tab) title name
        2. Yakuake terminal (tab) title name
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Customer Service
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: License :: Freely Distributable
Classifier: License :: Public Domain
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: Jython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Provides-Extra: optionals
