Module psdi_data_conversion.main_gui

main_gui.py

This script acts as a server for the PSDI Data Conversion Service website.

Functions

def main()

Expand source code

def main():
    """Standard entry-point function for this script.
    """

    parser = ArgumentParser(formatter_class=CustomHelpFormatter)

    parser.add_argument("--use-env-vars", action="store_true",
                        help="If set, all other arguments and defaults for this script are ignored, and environmental "
                        "variables and their defaults will instead control execution. These defaults will result in "
                        "the app running in production server mode.")

    parser.add_argument("--max-file-size", type=float, default=const.DEFAULT_MAX_FILE_SIZE/const.MEGABYTE,
                        help="The maximum allowed filesize in MB when not running in service mode - "
                        f"{tc.MESSAGE}0{tc.OFF} (default) indicates no maximum")

    parser.add_argument("--max-file-size-logged-in", type=float,
                        default=const.DEFAULT_MAX_FILE_SIZE_LOGGED_IN/const.MEGABYTE,
                        help="The maximum allowed filesize in MB for logged in users when running in service mode - "
                        f"{tc.MESSAGE}0{tc.OFF} (default) indicates no maximum")

    parser.add_argument("--max-file-size-logged-out", type=float,
                        default=const.DEFAULT_MAX_FILE_SIZE_LOGGED_OUT/const.MEGABYTE,
                        help="The maximum allowed filesize in MB for logged in users when running in service mode - "
                        f"{tc.MESSAGE}0{tc.OFF} (default) indicates no maximum")

    parser.add_argument("--max-file-size-ob", type=float, default=const.DEFAULT_MAX_FILE_SIZE_OB/const.MEGABYTE,
                        help="The maximum allowed filesize in MB for the Open Babel converter, taking precendence over "
                        f"the general maximum file size when Open Babel is used - {tc.MESSAGE}0{tc.OFF} indicates no "
                        f"maximum. Default {tc.MESSAGE}1{tc.OFF} MB.")

    parser.add_argument("--service-mode", action="store_true",
                        help="If set, will run as if deploying a service rather than the local GUI")

    parser.add_argument("--dev-mode", action="store_true",
                        help="If set, will expose development elements, such as the SHA of the latest commit")

    parser.add_argument("--debug", action="store_true",
                        help="If set, will run the Flask server in debug mode, which will cause it to automatically "
                        "reload if code changes and show an interactive debugger in the case of errors")
    parser.add_argument("--log-mode", type=str, default=const.LOG_SIMPLE,
                        help="How logs should be stored. Allowed values are: "
                        f"{tc.MESSAGE}'full'{tc.OFF}: Multi-file logging, not recommended for the CLI, but allowed "
                        "for a compatible interface with the public web app. "
                        f"{tc.MESSAGE}'simple'{tc.OFF}: Logs saved to one file. "
                        f"{tc.MESSAGE}'stdout'{tc.OFF}: Output logs and errors only to stdout. "
                        f"{tc.MESSAGE}'none'{tc.OFF}: Output only errors to stdout.")

    parser.add_argument("--log-level", type=str, default=None,
                        help=f"The desired level to log at. Allowed values are: {tc.MESSAGE}'DEBUG'{tc.OFF}, "
                        f"{tc.MESSAGE}'INFO'{tc.OFF}, {tc.MESSAGE}'WARNING'{tc.OFF}, {tc.MESSAGE}'ERROR'{tc.OFF}, "
                        f"{tc.MESSAGE}'CRITICAL'{tc.OFF}. Default: {tc.MESSAGE}'INFO'{tc.OFF} for logging to file, "
                        f"{tc.MESSAGE}'WARNING'{tc.OFF} for logging to stdout")

    # Set global variables for settings based on parsed arguments, unless it's set to use env vars
    args = parser.parse_args()

    if not args.use_env_vars:
        # Overwrite the values from environmental variables with the values from the command-line arguments
        update_env(args)

    # Set the upload limit based on provided arguments now
    limit_upload_size()

    print_wrap("Starting the PSDI Data Conversion GUI. This GUI is run as a webpage, which you can open by "
               "right-clicking the link below to open it in your default browser, or by copy-and-pasting it into your "
               "browser of choice.")

    start_app()

Standard entry-point function for this script.