Python script scaffold

script.py

#!/usr/bin/env python
import argparse
import logging
from pathlib import Path


# CONSTANTS -------------------------------------------------------------------


ROOT_DIR = Path(__file__).parent.resolve()


# COMMAND-LINE ARGUMENTS ------------------------------------------------------


_parser = argparse.ArgumentParser(description='TODO')
_parser.add_argument('input_path', type=Path, help='TODO')
_parser.add_argument('output_path', type=Path, help='TODO')


# LOGGING SETUP ---------------------------------------------------------------


_LOGGER = logging.getLogger(Path(__file__).stem)
_LOGGER.setLevel(logging.DEBUG)
_handler = logging.StreamHandler()
_formatter = logging.Formatter(
    '%(asctime)s - %(name)s - %(levelname)s - %(message)s')
_handler.setFormatter(_formatter)
_LOGGER.addHandler(_handler)


# HELPER FUNCTIONS ------------------------------------------------------------


# TODO: Add these.


# MAIN ------------------------------------------------------------------------


def main(args):
    """Run the overall script.

    Args:
        args: An argparse.Namespace with the following properties:
            TODO

    Returns:
        None
    """
    pass


if __name__ == '__main__':
    args = _parser.parse_args()
    main(args)