🚧 WIP: Begin exploring the GitLab API
- add PrettyTable for display This commit is very much WIP. Just some inital playing with the API. Eventually this should lead to a tool that will export at a minimum the wiki and issues for a project. First though, I need to get a feel for how the API works.
This commit is contained in:
parent
1d2a91b0af
commit
6343ee6db3
2 changed files with 158 additions and 6 deletions
|
|
@ -17,7 +17,8 @@ classifiers = [
|
||||||
"Operating System :: OS Independent",
|
"Operating System :: OS Independent",
|
||||||
]
|
]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"requests"
|
"prettytable",
|
||||||
|
"requests",
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.urls]
|
[project.urls]
|
||||||
|
|
|
||||||
|
|
@ -6,13 +6,164 @@ Copyright 2023 Neill Cox
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
import requests
|
||||||
|
from prettytable import PrettyTable
|
||||||
|
|
||||||
|
|
||||||
def hello_world():
|
def gitlab_url(path):
|
||||||
logging.debug("hello_world called")
|
return "https://gitlab.com/api/v4" + path
|
||||||
print("Hello World!")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
def get(url, args):
|
||||||
hello_world()
|
logging.debug("get called")
|
||||||
|
logging.debug("url: %s", url)
|
||||||
|
|
||||||
|
response = requests.get(url, headers={"PRIVATE-TOKEN": args.gitlab_token})
|
||||||
|
|
||||||
|
logging.debug("response.status: %s", response.status_code)
|
||||||
|
logging.debug("body: %s", response.text)
|
||||||
|
|
||||||
|
return response.json()
|
||||||
|
|
||||||
|
|
||||||
|
def parse_args():
|
||||||
|
"""Parse the command line arguments"""
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument(
|
||||||
|
"-t",
|
||||||
|
"--gitlab-token",
|
||||||
|
help=(
|
||||||
|
"A private access token to access GitLab with. If not specified "
|
||||||
|
"will use $GL_TOKEN. Required."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
parser.add_argument("--debug", action="store_true")
|
||||||
|
parser.add_argument("--log-file", default="gitlab2gitea.log")
|
||||||
|
|
||||||
|
subparsers = parser.add_subparsers()
|
||||||
|
|
||||||
|
lp_sp = subparsers.add_parser("list-projects")
|
||||||
|
lp_sp.set_defaults(func=list_projects)
|
||||||
|
|
||||||
|
lp_sp = subparsers.add_parser("get-user")
|
||||||
|
lp_sp.set_defaults(func=cli_get_user)
|
||||||
|
|
||||||
|
lp_sp = subparsers.add_parser("get-project-details")
|
||||||
|
lp_sp.add_argument("--project", required=True)
|
||||||
|
lp_sp.set_defaults(func=get_project_details)
|
||||||
|
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
log_level = logging.INFO
|
||||||
|
if args.debug:
|
||||||
|
log_level = logging.DEBUG
|
||||||
|
|
||||||
|
logging.basicConfig(filename=args.log_file, level=log_level)
|
||||||
|
|
||||||
|
if args.gitlab_token is None:
|
||||||
|
args.gitlab_token = os.environ.get("GL_TOKEN")
|
||||||
|
|
||||||
|
if args.gitlab_token is None:
|
||||||
|
err_str = "/".join(
|
||||||
|
[ac for ac in parser._actions if ac.dest == "gitlab_token"][
|
||||||
|
0
|
||||||
|
].option_strings
|
||||||
|
)
|
||||||
|
parser.print_usage()
|
||||||
|
|
||||||
|
print(
|
||||||
|
f"{parser.prog}: error: the following arguments are "
|
||||||
|
f"required: {err_str}"
|
||||||
|
)
|
||||||
|
sys.exit(2)
|
||||||
|
|
||||||
|
if "func" in args:
|
||||||
|
args.func(args)
|
||||||
|
|
||||||
|
return args
|
||||||
|
|
||||||
|
|
||||||
|
def cli_get_user(args):
|
||||||
|
logging.debug("cli_get_user called")
|
||||||
|
|
||||||
|
user = get_user(args)
|
||||||
|
|
||||||
|
print(json.dumps(user))
|
||||||
|
|
||||||
|
|
||||||
|
def get_user(args):
|
||||||
|
logging.debug("get_user called")
|
||||||
|
|
||||||
|
url = gitlab_url("/user")
|
||||||
|
|
||||||
|
result = get(url, args)
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def list_projects(args):
|
||||||
|
logging.debug("list_projects called")
|
||||||
|
user_id = get_user(args)["id"]
|
||||||
|
|
||||||
|
url = gitlab_url(
|
||||||
|
f"/users/{user_id}/projects?pagination=offset&per_page=500&"
|
||||||
|
"order_by=name&sort=asc"
|
||||||
|
)
|
||||||
|
|
||||||
|
result = get(url, args)
|
||||||
|
|
||||||
|
tbl = PrettyTable()
|
||||||
|
tbl.align = "l"
|
||||||
|
tbl.field_names = [
|
||||||
|
"ID",
|
||||||
|
"Name",
|
||||||
|
# "Description"
|
||||||
|
]
|
||||||
|
|
||||||
|
for row in result:
|
||||||
|
tbl.add_row(
|
||||||
|
[
|
||||||
|
row["id"],
|
||||||
|
row["name"],
|
||||||
|
# row["description"][:50] if row["description"] else ""
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
print(tbl)
|
||||||
|
|
||||||
|
|
||||||
|
def get_project_details(args):
|
||||||
|
user_id = get_user(args)["id"]
|
||||||
|
url = gitlab_url(
|
||||||
|
f"/users/{user_id}/projects?pagination=offset&per_page=500&"
|
||||||
|
"order_by=name&sort=asc"
|
||||||
|
)
|
||||||
|
|
||||||
|
response = get(url, args)
|
||||||
|
|
||||||
|
project = [
|
||||||
|
project
|
||||||
|
for project in response
|
||||||
|
if (project["name"] == args.project or project["id"] == args.project)
|
||||||
|
][0]
|
||||||
|
|
||||||
|
if not project:
|
||||||
|
raise KeyError(f"Project {args.project} not found")
|
||||||
|
|
||||||
|
print(json.dumps(project))
|
||||||
|
|
||||||
|
|
||||||
|
def exporter():
|
||||||
|
args = parse_args()
|
||||||
|
list_projects(args)
|
||||||
|
|
||||||
|
# user = get_user(args)
|
||||||
|
# args.user_id = user['id']
|
||||||
|
# print(json.dumps(get_project_details(args)))
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue