build_docs.py

# STDLIB Imports
import argparse
import datetime
import errno
import logging
import os
import sys


# OWN
import lib_log_utils

if sys.version_info < (3, 6):
    lib_log_utils.add_stream_handler()
    main_logger = logging.getLogger('init')
    main_logger.error('only Python Versions from 3.6 are supported')
    sys.exit(1)
else:
    # OWN
    from rst_include import *

# CONSTANTS & PROJECT SPECIFIC FUNCTIONS
codeclimate_link_hash = ""


def project_specific(repository_slug, repository, repository_dashed):
    # PROJECT SPECIFIC
    logger = logging.getLogger('project_specific')
    pass


def parse_args(cmd_args=sys.argv[1:]):
    # type: ([]) -> []
    parser = argparse.ArgumentParser(
        description='Create Readme.rst',
        epilog='check the documentation on github',
        add_help=True)

    parser.add_argument('travis_repo_slug', metavar='TRAVIS_REPO_SLUG in the form "<github_account>/<repository>"')
    args = parser.parse_args(cmd_args)
    return args, parser


def main(args):
    logger = logging.getLogger('build_docs')
    logger.info('create the README.rst')
    travis_repo_slug = args.travis_repo_slug
    repository = travis_repo_slug.split('/')[1]
    repository_dashed = repository.replace('_', '-')

    project_specific(travis_repo_slug, repository, repository_dashed)

    """
    paths absolute, or relative to the location of the config file
    the notation for relative files is like on windows or linux - not like in python.
    so You might use ../../some/directory/some_document.rst to go two levels back.
    avoid absolute paths since You never know where the program will run.
    """

    logger.info('include the include blocks')
    rst_inc(source='./.docs/README_template.rst',
            target='./README.rst')

    logger.info('replace repository related strings')
    rst_str_replace(source='./README.rst',
                    target='',
                    old='{repository_slug}',
                    new=travis_repo_slug,
                    inplace=True)
    rst_str_replace(source='./README.rst',
                    target='',
                    old='{repository}',
                    new=repository,
                    inplace=True)
    rst_str_replace(source='./README.rst',
                    target='',
                    old='{repository_dashed}',
                    new=repository_dashed,
                    inplace=True)

    rst_include.rst_str_replace(source='./README.rst', target='', old='{last_update_yyyy}', new=str(datetime.date.today().year+1), inplace=True)

    rst_str_replace(source='./README.rst',
                    target='',
                    old='{codeclimate_link_hash}',
                    new=codeclimate_link_hash,
                    inplace=True)

    logger.info('done')
    sys.exit(0)


if __name__ == '__main__':
    lib_log_utils.add_stream_handler()
    main_logger = logging.getLogger('main')
    try:
        _args, _parser = parse_args()

        main(_args)
    except FileNotFoundError:
        # see https://www.thegeekstuff.com/2010/10/linux-error-codes for error codes
        sys.exit(errno.ENOENT)      # No such file or directory
    except FileExistsError:
        sys.exit(errno.EEXIST)      # File exists
    except TypeError:
        sys.exit(errno.EINVAL)      # Invalid Argument
    except ValueError:
        sys.exit(errno.EINVAL)      # Invalid Argument