Metadata-Version: 2.1
Name: pyInstallPackage
Version: 0.1
Summary: Standard app packaging
Home-page: https://github.com/20centcroak/pyPackage
Author: 20centCroak
Author-email: 
License: UNKNOWN
Description: 
        # pyPackage module
        
        ## Description
        pyPackage module makes use of Pyinstaller to build an app package ready to go.
        It is a wrapper to ease the use of Pyinstaller.
        It defines the build parameters in a settings file (yml file) and also add the ability to add external documents (documentation, config files, ...) and a launcher (.bat or .sh file)
        
        Note that Pyinstaller builds executable files according to the OS on which the program is exectuted :
        - if executed on Windows, a windows executable file is generated
        - if executed on Linux, a linux executable file is generated
        
        ## Example
        Here is a basic example of use:
        
            from pyBaseApp.package import Package, Options
            from pyBaseApp.applauncher import Configuration
             
            settings = Configuration().settings('settings.yml')
            try:
                options = Options(settings)
                Package(options, data)
            except ValueError:
                print('package value is missing in settings')
        
        Where *settings.yml* could be:
        
            name: myApp
            package: C:/scripts/my_app.py
            distpath: C:/dist/myApp
            data: 
            - src: C:/scripts/resources/myapp.yml
                root_level: true
            - src: C:/scripts/resources/README.md
                root_level: true
            - src: C:\data\github\work\scripts\doc\easyPresentation\images
                dst: images
                root_level: true
            sh:
                path: mypath
                options:
                    l: myloggerpath
                    s: mysettingspath
        
        
        ## List of available options:
        
        
        Pynstaller options and default values (See [pyinstaller documentation](https://pyinstaller.readthedocs.io/en/stable/) for more info):
        
            name = None
            onefile=False
            console=True
            binaries = dict()
            icon = None
            distpath = None
            workpath = None
            specpath = 'pyinstaller'
            paths = []
            clean = True
            loglevel = loglevels.DEBUG.name
            hiddenimports = []
            additionalhooks = []
            runtimehooks = []
            excludemodules = []
            package = None
            no_confirm = True
        
        
        addons options :
        
            data = None
            version = None
            sh = None
            bat = None
        
        
        Examples of data and sh structures are given above
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
