Metadata-Version: 1.1
Name: nf
Version: 1.0.1
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
        ==============
        
        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: jsonfromschema
        License: 0BSD / Free Public License 1.0.0
        More information about license: https://opensource.org/licenses/0BSD
        
        
        
        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
        
            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
            -----------------------------------------------------------
        
        TODO
        ----
        
        1. Save notification to file
        
        LIMITATION:
        1. Work with Jython: it does not have dbus module, fallback to command line.
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
