docs(example): add python script to generate config based on gitlab group (#337)

Author: Andreas Schleifer

scripts/generate_gitlab.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python
+
+import argparse
+import os
+import sys
+
+import requests
+import yaml
+
+try:
+    gitlab_token = os.environ["GITLAB_TOKEN"]
+except KeyError:
+    print("Please provide the environment variable GITLAB_TOKEN")
+    sys.exit(1)
+
+parser = argparse.ArgumentParser(
+    description="Script to generate vcsconfig for all repositories \
+    under the given namespace (needs Gitlab >= 10.3)"
+)
+parser.add_argument("gitlab_host", type=str, help="url to the gitlab instance")
+parser.add_argument(
+    "gitlab_namespace",
+    type=str,
+    help="namespace/group in gitlab to generate vcsconfig for",
+)
+parser.add_argument(
+    "-c",
+    type=str,
+    help="path to the target config file (default: ./vcspull.yaml)",
+    dest="config_file_name",
+    required=False,
+    default="./vcspull.yaml",
+)
+
+args = vars(parser.parse_args())
+gitlab_host = args["gitlab_host"]
+gitlab_namespace = args["gitlab_namespace"]
+config_filename = args["config_file_name"]
+
+try:
+    if os.path.isfile(config_filename):
+        result = input(
+            "The target config file (%s) already exists, \
+            do you want to overwrite it? [y/N] "
+            % (config_filename)
+        )
+
+        if result != "y":
+            print(
+                "Aborting per user request as existing config file (%s) \
+                should not be overwritten!"
+                % (config_filename)
+            )
+            sys.exit(0)
+
+    config_file = open(config_filename, "w")
+except IOError:
+    print("File %s not accesible" % (config_filename))
+    sys.exit(1)
+
+result = requests.get(
+    "%s/api/v4/groups/%s/projects" % (gitlab_host, gitlab_namespace),
+    params={"include_subgroups": "true", "per_page": "100"},
+    headers={"Authorization": "Bearer %s" % (gitlab_token)},
+)
+
+if 200 != result.status_code:
+    print("Error: ", result)
+    sys.exit(1)
+
+path_prefix = os.getcwd()
+config = {}
+
+for group in result.json():
+    url_to_repo = group["ssh_url_to_repo"].replace(":", "/")
+    namespace_path = group["namespace"]["full_path"]
+    reponame = group["path"]
+
+    path = "%s/%s" % (path_prefix, namespace_path)
+
+    if path not in config:
+        config[path] = {}
+
+    # simplified config not working - https://github.com/vcs-python/vcspull/issues/332
+    # config[path][reponame] = 'git+ssh://%s' % (url_to_repo)
+
+    config[path][reponame] = {
+        "url": "git+ssh://%s" % (url_to_repo),
+        "remotes": {"origin": "ssh://%s" % (url_to_repo)},
+    }
+
+config_yaml = yaml.dump(config)
+
+print(config_yaml)
+
+config_file.write(config_yaml)
+config_file.close()