config_exportPdfFromHtml_template.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""Sets up the local environment of the user for the script exportPdfFromHtml.py

Sets up the local environment of the user for the script exportPdfFromHtml.py

As it is a template, please copy it first to a file named 
"config_exportPdfFromHtml.py"!

After copy, it is strongly recommended to setup all necessary parameters in 
the init() function, before running the script exportPdfFromHtml.py 
for the first time.
"""

import os


# ---------------------------
def init() -> dict:
    """
    setup all necessary parameters for this script to work.
    
    Parameter
    ---------
    none

    Rerturns
    --------
    dictionary
        all global program parameters are stored there
    """
    print("DEBUG: init()")

    parameters = {}
    
    # evaluate the absolut path to this script file and set it as 
    # project root dir
    # DO NOT CHANGE!
    aPath = os.path.realpath(__file__)
    aPath = os.path.dirname(aPath)
    aPath = os.path.normpath(aPath)

    # all the HTML files with the file extensions ".html"
    # will get read for export into the PDF format
    # DO NOT CHANGE!
    parameters['html_input_path'] = os.path.join(aPath, "_www")

    # DO NOT CHANGE!
    parameters['pdf_output_path'] = os.path.join(aPath, "_pdf")

    # absolut path to the current Users windows home path
    # DO NOT CHANGE!
    parameters['user_home_path'] = os.path.join(
        os.environ['HOMEDRIVE'], os.sep, os.environ['HOMEPATH'])

    # absolut path to the root folder of all application installations
    # DO NOT CHANGE!
    apps_installation_root = os.path.join(
        parameters['user_home_path'], "installations")

    # CHANGE THIS!
    # absolut path to the draw.io app
    parameters['wkhtmltopdf_app_path'] = os.path.join(apps_installation_root, 
        "wkhtmltox", 
        "bin", 
        "wkhtmltopdf.exe")

    
    return parameters