def setUp(self):
        """ Generate API Documentation

        """
        base_path = self.get_base_path()

        monolithe_config = MonolitheConfig.config_with_path("%s/conf/conf.ini" % base_path)
        generator = APIDocumentationGenerator(monolithe_config=monolithe_config)
        generator.generate_from_folder(folder="%s/specifications" % base_path)
Esempio n. 2
0
    def setUp(self):
        """ Generate API Documentation

        """
        base_path = self.get_base_path()

        monolithe_config = MonolitheConfig.config_with_path(
            "%s/conf/conf.ini" % base_path)
        generator = APIDocumentationGenerator(
            monolithe_config=monolithe_config)
        generator.generate_from_folder(folder="%s/specifications" % base_path)
Esempio n. 3
0
def main(argv=sys.argv):
    """
    """
    parser = argparse.ArgumentParser(description="Generates an API documentation from a specification set")

    parser.add_argument("-g", "--github",
                        dest="api_url",
                        metavar="github_api_url",
                        help="The GitHub API URL. Can be given by setting the environment variable \"MONOLITHE_GITHUB_API_URL\"",
                        type=str)

    parser.add_argument("-l", "--login",
                        dest="login",
                        metavar="login_login",
                        help="The GitHub Login (if set, you will be prompted for your password). Can be given by setting the environment variable \"MONOLITHE_GITHUB_LOGIN\"",
                        type=str)

    parser.add_argument("-t", "--token",
                        dest="token",
                        metavar="github_token",
                        help="The GitHub Token (if set, --login will be ignored). To generate a token, go here https://github.com/settings/tokens. Can be given by setting the environment variable \"$MONOLITHE_GITHUB_TOKEN\"",
                        type=str)

    parser.add_argument("-o", "--organization",
                        dest="organization",
                        metavar="github_organization",
                        help="The GitHub Organization. Can be given by setting the environment variable \"MONOLITHE_GITHUB_ORGANIZATION\"",
                        type=str)

    parser.add_argument("-r", "--repository",
                        dest="repository",
                        metavar="github_repository",
                        help="The GitHub Repository. Can be given by setting the environment variable \"MONOLITHE_GITHUB_REPOSITORY\"",
                        type=str)

    parser.add_argument("-p", "--path",
                        dest="repository_path",
                        metavar="path",
                        help="The relative repository path of the specification folder. Can be given by setting the environment variable \"MONOLITHE_GITHUB_REPOSITORY_PATH\"",
                        type=str)

    parser.add_argument("-b", "--branches",
                        dest="branches",
                        metavar="branches",
                        help="The branches of the specifications to use to generate the documentation (examples: \"master 3.2\")",
                        nargs="*",
                        type=str)

    parser.add_argument("-f", "--folder",
                        dest="folder",
                        metavar="folder",
                        help="Path of the specifications folder. If set, all other attributes will be ignored",
                        type=str)

    parser.add_argument("-c", "--config",
                        dest="config_path",
                        metavar="config_path",
                        help="Path the monolithe configuration file",
                        type=str)

    parser.add_argument("--vanilla-prefix",
                        dest="vanilla_prefix",
                        help="Prefix added to all vanilla path declared in the monolithe configuration file",
                        required=False,
                        type=str)

    args = parser.parse_args()

    monolithe_config = None
    if args.config_path:
        monolithe_config = MonolitheConfig.config_with_path(args.config_path)

    if monolithe_config and args.vanilla_prefix:
        monolithe_config.set_option("sdk_user_vanilla", "%s/%s" % (args.vanilla_prefix, monolithe_config.get_option("sdk_user_vanilla", "sdk")), "sdk")
        monolithe_config.set_option("sdkdoc_user_vanilla", "%s/%s" % (args.vanilla_prefix, monolithe_config.get_option("sdkdoc_user_vanilla", "sdkdoc")), "sdkdoc")
        monolithe_config.set_option("apidoc_user_vanilla", "%s/%s" % (args.vanilla_prefix, monolithe_config.get_option("apidoc_user_vanilla", "apidoc")), "apidoc")

    generator = APIDocumentationGenerator(monolithe_config=monolithe_config)

    if args.folder:
        generator.initialize_folder_manager(folder=args.folder)
        if not monolithe_config: generator.retrieve_monolithe_config_from_folder()
        generator.generate_from_folder()
    else:
        # Use environment variable if necessary
        if not args.api_url and "MONOLITHE_GITHUB_API_URL" in os.environ:
            args.api_url = os.environ["MONOLITHE_GITHUB_API_URL"]

        if not args.token and not args.login:

            if "MONOLITHE_GITHUB_TOKEN" in os.environ:
                args.token = os.environ["MONOLITHE_GITHUB_TOKEN"]

            elif "MONOLITHE_GITHUB_LOGIN" in os.environ:
                args.login = os.environ["MONOLITHE_GITHUB_LOGIN"]

        if not args.organization and "MONOLITHE_GITHUB_ORGANIZATION" in os.environ:
            args.organization = os.environ["MONOLITHE_GITHUB_ORGANIZATION"]

        if not args.repository and "MONOLITHE_GITHUB_REPOSITORY" in os.environ:
            args.repository = os.environ["MONOLITHE_GITHUB_REPOSITORY"]

        if not args.repository_path and "MONOLITHE_GITHUB_REPOSITORY_PATH" in os.environ:
            args.repository_path = os.environ["MONOLITHE_GITHUB_REPOSITORY_PATH"]

        if not args.config_path and "MONOLITHE_CONFIG_PATH" in os.environ:
            args.config_path = os.environ["MONOLITHE_CONFIG_PATH"]

        if not args.login and not args.token:
            args.login = raw_input("Enter your GitHub login: "******"/"

        # Ask for password
        if args.login:
            password = getpass.getpass(prompt="Enter your GitHub password for %s: " % args.login)
            login_or_token = args.login
        else:
            password = None
            login_or_token = args.token

        generator.initialize_repository_manager(api_url=args.api_url,
                                                login_or_token=login_or_token,
                                                password=password,
                                                organization=args.organization,
                                                repository=args.repository,
                                                repository_path=args.repository_path)

        if not monolithe_config: generator.retrieve_monolithe_config_from_repo(branch=args.branches[0])
        generator.generate_from_repo(branches=args.branches)
Esempio n. 4
0
def main(argv=sys.argv):
    """
    """
    parser = argparse.ArgumentParser(
        description="Generates an API documentation from a specification set")

    parser.add_argument(
        "-g",
        "--github",
        dest="api_url",
        metavar="github_api_url",
        help=
        "The GitHub API URL. Can be given by setting the environment variable \"MONOLITHE_GITHUB_API_URL\"",
        type=str)

    parser.add_argument(
        "-l",
        "--login",
        dest="login",
        metavar="login_login",
        help=
        "The GitHub Login (if set, you will be prompted for your password). Can be given by setting the environment variable \"MONOLITHE_GITHUB_LOGIN\"",
        type=str)

    parser.add_argument(
        "-t",
        "--token",
        dest="token",
        metavar="github_token",
        help=
        "The GitHub Token (if set, --login will be ignored). To generate a token, go here https://github.com/settings/tokens. Can be given by setting the environment variable \"$MONOLITHE_GITHUB_TOKEN\"",
        type=str)

    parser.add_argument(
        "-o",
        "--organization",
        dest="organization",
        metavar="github_organization",
        help=
        "The GitHub Organization. Can be given by setting the environment variable \"MONOLITHE_GITHUB_ORGANIZATION\"",
        type=str)

    parser.add_argument(
        "-r",
        "--repository",
        dest="repository",
        metavar="github_repository",
        help=
        "The GitHub Repository. Can be given by setting the environment variable \"MONOLITHE_GITHUB_REPOSITORY\"",
        type=str)

    parser.add_argument(
        "-p",
        "--path",
        dest="repository_path",
        metavar="path",
        help=
        "The relative repository path of the specification folder. Can be given by setting the environment variable \"MONOLITHE_GITHUB_REPOSITORY_PATH\"",
        type=str)

    parser.add_argument(
        "-b",
        "--branches",
        dest="branches",
        metavar="branches",
        help=
        "The branches of the specifications to use to generate the documentation (examples: \"master 3.2\")",
        nargs="*",
        type=str)

    parser.add_argument(
        "-f",
        "--folder",
        dest="folder",
        metavar="folder",
        help=
        "Path of the specifications folder. If set, all other attributes will be ignored",
        type=str)

    parser.add_argument("-c",
                        "--config",
                        dest="config_path",
                        metavar="config_path",
                        help="Path the monolithe configuration file",
                        type=str)

    parser.add_argument(
        "--vanilla-prefix",
        dest="vanilla_prefix",
        help=
        "Prefix added to all vanilla path declared in the monolithe configuration file",
        required=False,
        type=str)

    args = parser.parse_args()

    monolithe_config = None
    if args.config_path:
        monolithe_config = MonolitheConfig.config_with_path(args.config_path)

    if monolithe_config and args.vanilla_prefix:
        monolithe_config.set_option(
            "sdk_user_vanilla",
            "%s/%s" % (args.vanilla_prefix,
                       monolithe_config.get_option("sdk_user_vanilla", "sdk")),
            "sdk")
        monolithe_config.set_option(
            "sdkdoc_user_vanilla", "%s/%s" %
            (args.vanilla_prefix,
             monolithe_config.get_option("sdkdoc_user_vanilla", "sdkdoc")),
            "sdkdoc")
        monolithe_config.set_option(
            "apidoc_user_vanilla", "%s/%s" %
            (args.vanilla_prefix,
             monolithe_config.get_option("apidoc_user_vanilla", "apidoc")),
            "apidoc")

    generator = APIDocumentationGenerator(monolithe_config=monolithe_config)

    if args.folder:
        generator.initialize_folder_manager(folder=args.folder)
        if not monolithe_config:
            generator.retrieve_monolithe_config_from_folder()
        generator.generate_from_folder()
    else:
        # Use environment variable if necessary
        if not args.api_url and "MONOLITHE_GITHUB_API_URL" in os.environ:
            args.api_url = os.environ["MONOLITHE_GITHUB_API_URL"]

        if not args.token and not args.login:

            if "MONOLITHE_GITHUB_TOKEN" in os.environ:
                args.token = os.environ["MONOLITHE_GITHUB_TOKEN"]

            elif "MONOLITHE_GITHUB_LOGIN" in os.environ:
                args.login = os.environ["MONOLITHE_GITHUB_LOGIN"]

        if not args.organization and "MONOLITHE_GITHUB_ORGANIZATION" in os.environ:
            args.organization = os.environ["MONOLITHE_GITHUB_ORGANIZATION"]

        if not args.repository and "MONOLITHE_GITHUB_REPOSITORY" in os.environ:
            args.repository = os.environ["MONOLITHE_GITHUB_REPOSITORY"]

        if not args.repository_path and "MONOLITHE_GITHUB_REPOSITORY_PATH" in os.environ:
            args.repository_path = os.environ[
                "MONOLITHE_GITHUB_REPOSITORY_PATH"]

        if not args.config_path and "MONOLITHE_CONFIG_PATH" in os.environ:
            args.config_path = os.environ["MONOLITHE_CONFIG_PATH"]

        if not args.login and not args.token:
            args.login = raw_input("Enter your GitHub login: "******"/"

        # Ask for password
        if args.login:
            password = getpass.getpass(
                prompt="Enter your GitHub password for %s: " % args.login)
            login_or_token = args.login
        else:
            password = None
            login_or_token = args.token

        generator.initialize_repository_manager(
            api_url=args.api_url,
            login_or_token=login_or_token,
            password=password,
            organization=args.organization,
            repository=args.repository,
            repository_path=args.repository_path)

        if not monolithe_config:
            generator.retrieve_monolithe_config_from_repo(
                branch=args.branches[0])
        generator.generate_from_repo(branches=args.branches)