Metadata-Version: 1.1
Name: pymain
Version: 0.3.1
Summary: A simplified interface for your main function.
Home-page: https://github.com/jasongraffius/pymain
Author: Jason Graffius
Author-email: UNKNOWN
License: MIT
Description: Pymain
        ======
        
        Pymain - Simplified main
        
        Pymain is a decorator and related tools to simplify your ``main`` function(s).
        It is intended to be more simple to use and understand than ``argparse``, while
        still providing most of the functionality of similar libraries.
        
        Description
        -----------
        
        The basic idea of ``pymain`` is that your main function (though it doesn't need
        to be called "main"), and therefore your script or application itself, probably
        takes parameters and keyword arguments in the form of command line arguments.
        Since that interface works very similar to calling a python function, ``pymain``
        translates between those interfaces for you. In addition, so many scripts with
        entry points include the ``if __name__ == '__main__':`` boilerplate, and pymain
        aims to eliminate that.
        
        Usage
        -----
        
        Import and use the ``@pymain`` decorator before your main function that has type
        annotations for the parameters. If you don't need any short options or aliases,
        that is all you need to do. Pymain will detect whether the defining module is
        run as a script (and therefore ``__name__ == "__main__"``) or if it is being
        imported. If it is run as a script, then main will be called and given arguments
        based on ``sys.argv``. If it is imported, then pymain will not run the function
        as a main function and it can still be called normally.
        
        Pymain uses the type annotations to determine what types to expect. For short
        options or aliases, you can add an ``@alias`` decorator after the ``@pymain``
        decorator describing the alias (either a single alias or a dictionary of
        multiple)
        
        All arguments that are greater than one character in length are long options
        (e.g. --arg), and arguments that have a single character are short options
        (e.g. -a). Aliases follow the same rules.
        
        Examples
        --------
        
        optional.py:
        
        .. code:: python
        
            from pymain import pymain
        
            @pymain
            def main(a: float, b: float, c: str = None):
                print(a / b)
                if c is not None:
                    print(c)
        
        Command line:
        
        .. code:: bash
        
            ~ $ python optional.py 4 2
            2.0
        
        .. code:: bash
        
            ~ $ python optional.py 9 2 message
            4.5
            message
        
        --------------
        
        keyword.py:
        
        .. code:: python
        
            from pymain import pymain
        
            @pymain
            def main(first: int, second: int, *, message: str = None):
                print(first + second)
                if message is not None:
                    print(message)
        
        Command line:
        
        .. code:: bash
        
            ~ $ python main.py 4 6
            10
        
        .. code:: bash
        
            ~ $ python main.py 1 2 --message "Hello, World!"
            3
            Hello, World!
        
        --------------
        
        alias.py:
        
        .. code:: python
        
            from pymain import pymain, alias
        
            @pymain
            @alias({"opt1": "x", "opt2": "y"})
            def foo(value: float, *, opt1: float = 1.0, opt2: float = 2.0):
                print(value + opt1)
                print(value - opt2)
        
        Command line:
        
        .. code:: bash
        
            ~ $ python alias.py 2
            3.0
            0.0
        
        .. code:: bash
        
            ~ $ python alias.py 5 -x 1 -y 1
            6.0
            4.0
        
        .. code:: bash
        
            ~ $ python alias.py 10 --opt1 5 --opt2 2
            15.0
            8.0
Keywords: main arguments option argparse
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: Utilities
