glpkg 0.0.1__py3-none-any.whl → 1.1.0__py3-none-any.whl

gitlab/__init__.py

@@ -1,3 +1,3 @@
 from gitlab.packages import Packages
 
-__version__ = "0.0.1"
+__version__ = "1.1.0"

gitlab/cli_handler.py

@@ -1,4 +1,5 @@
 import argparse
+import netrc
 import os
 from gitlab import Packages, __version__
 
@@ -47,7 +48,7 @@ class CLIHandler:
             "-c",
             "--ci",
             action="store_true",
-            help="Use this to run the tool in GitLab pipelines. In this case CI_SERVER_HOST, CI_PROJECT_ID, and CI_JOB_TOKEN variables from the environment are used. --project and --token can be used to override project ID and the CI_JOB_TOKEN to a personal or project access token.",
+            help="Use this in GitLab jobs. In this case CI_SERVER_HOST, CI_PROJECT_ID, and CI_JOB_TOKEN variables from the environment are used. --project and --token can be used to override project ID and the CI_JOB_TOKEN to a personal or project access token.",
         )
         parser.add_argument(
             "-p",
@@ -56,12 +57,18 @@ class CLIHandler:
             help="The project ID or path. For example 123456 or namespace/project.",
         )
         parser.add_argument("-n", "--name", type=str, help="The package name.")
-        parser.add_argument(
+        group2 = parser.add_mutually_exclusive_group()
+        group2.add_argument(
             "-t",
             "--token",
             type=str,
             help="Private or project access token that is used to authenticate with the package registry. Leave empty if the registry is public. The token must have 'read API' or 'API' scope.",
         )
+        group2.add_argument(
+            "--netrc",
+            action="store_true",
+            help="Set to use a token from .netrc file (~/.netrc) for the host. The .netrc username is ignored due to API restrictions. PRIVATE-TOKEN is used instead. Note that .netrc file access rights must be correct.",
+        )
 
     def _register_download_parser(self, parser):
         self._register_common_arguments(parser)
@@ -71,35 +78,40 @@ class CLIHandler:
     def _args(self, args):
         if args.ci:
             host = os.environ["CI_SERVER_HOST"]
+            project = os.environ["CI_PROJECT_ID"]
+            token = os.environ["CI_JOB_TOKEN"]
+            token_user = "JOB-TOKEN"
             if args.project:
                 project = args.project
-            else:
-                project = os.environ["CI_PROJECT_ID"]
             if args.token:
-                token_user = "PRIVATE-TOKEN"
                 token = args.token
-            else:
-                token_user = "JOB-TOKEN"
-                token = os.environ["CI_JOB_TOKEN"]
+                token_user = "PRIVATE-TOKEN"
         else:
             host = args.host
             project = args.project
-            token_user = "PRIVATE-TOKEN"
             token = args.token
+            token_user = "PRIVATE-TOKEN"
+        if args.netrc:
+            _, _, token = netrc.netrc().authenticators(host)
+            token_user = "PRIVATE-TOKEN"
         name = args.name
         return host, project, name, token_user, token
 
     def _download_handler(self, args) -> int:
+        ret = 1
         host, project, name, token_user, token = self._args(args)
         version = args.version
         gitlab = Packages(host, token_user, token)
         package_id = gitlab.get_package_id(project, name, version)
-        files = gitlab.list_files(project, package_id)
-        ret = 1
-        for file in files:
-            ret = gitlab.download_file(project, name, version, file)
-            if not ret:
-                break
+        if package_id:
+            files = gitlab.list_files(project, package_id)
+            for file in files:
+                ret = gitlab.download_file(project, name, version, file)
+                if ret:
+                    print("Failed to download file " + file)
+                    break
+        else:
+            print("No package " + name + " version " + version + " found!")
         return ret
 
     def _register_list_parser(self, parser):
@@ -126,9 +138,13 @@ class CLIHandler:
         parser.set_defaults(action=self._upload)
 
     def _upload(self, args) -> int:
+        ret = 1
         host, project, name, token_user, token = self._args(args)
         version = args.version
         file = args.file
-        gitlab = Packages(host, token_user, token)
-        ret = gitlab.upload_file(project, name, version, file)
+        if os.path.isfile(file):
+            gitlab = Packages(host, token_user, token)
+            ret = gitlab.upload_file(project, name, version, file)
+        else:
+            print("File " + file + " does not exist!")
         return ret

gitlab/packages.py

@@ -1,6 +1,10 @@
+from http.client import HTTPMessage
 import json
+import logging
 from urllib import request, parse
 
+logger = logging.getLogger(__name__)
+
 
 class Packages:
     def __init__(self, host: str, token_type: str, token: str):
@@ -14,95 +18,123 @@ class Packages:
     def project_api_url(self, project: str) -> str:
         return self.api_url() + "projects/{}/".format(parse.quote_plus(project))
 
-    def get_headers(self):
+    def get_headers(self) -> dict:
         headers = {}
         if self.token_type and self.token:
             headers = {self.token_type: self.token}
         return headers
 
+    def _request(self, url: str) -> tuple[int, bytes, HTTPMessage]:
+        logger.debug("Requesting " + url)
+        req = request.Request(url, headers=self.get_headers())
+        with request.urlopen(req) as response:
+            return response.status, response.read(), response.headers
+
+    def _get_next_page(self, headers: HTTPMessage) -> int:
+        ret = 0
+        if headers:
+            next_page = headers.get("x-next-page")
+            if next_page:
+                ret = int(next_page)
+                logger.debug("Response incomplete, next page is " + next_page)
+            else:
+                logger.debug("Response complete")
+        return ret
+
+    def _build_query(self, arg: str, page: int) -> str:
+        query = ""
+        if arg or page:
+            if page:
+                page = "page=" + str(page)
+            query = "?{}".format("&".join(filter(None, (arg, page))))
+        return query
+
+    def gl_project_api(self, project: str, path: str, arg: str = None) -> list:
+        data = []
+        more = True
+        page = None
+        while more:
+            more = False
+            query = self._build_query(arg, page)
+            url = self.project_api_url(project) + path + query
+            status, res_data, headers = self._request(url)
+            logger.debug("Response status: " + str(status))
+            res_data = json.loads(res_data)
+            logger.debug("Response data: " + str(res_data))
+            data = data + res_data
+            page = self._get_next_page(headers)
+            if page:
+                more = True
+        return data
+
     def list_packages(self, project: str, package_name: str) -> list:
         packages = []
-        with request.urlopen(
-            request.Request(
-                self.project_api_url(project)
-                + "packages?package_name="
-                + parse.quote_plus(package_name),
-                headers=self.get_headers(),
-            )
-        ) as res:
-            data = res.read()
-            for package in json.loads(data):
-                name = parse.unquote(package["name"])
-                version = parse.unquote(package["version"])
-                # The GitLab API returns packages that have some match to the filter;
-                # let's filter out non-exact matches
-                if package_name != name:
-                    continue
-                packages.append({"name": name, "version": version})
+        logger.debug("Listing packages with name " + package_name)
+        data = self.gl_project_api(
+            project, "packages", "package_name=" + parse.quote_plus(package_name)
+        )
+        for package in data:
+            name = parse.unquote(package["name"])
+            version = parse.unquote(package["version"])
+            # GitLab API returns packages that have some match to the filter;
+            # let's filter out non-exact matches
+            if package_name != name:
+                continue
+            packages.append({"name": name, "version": version})
         return packages
 
     def list_files(self, project: str, package_id: int) -> list:
         files = []
-        with request.urlopen(
-            request.Request(
-                self.project_api_url(project)
-                + "packages/"
-                + parse.quote_plus(str(package_id))
-                + "/package_files",
-                headers=self.get_headers(),
-            )
-        ) as x:
-            data = x.read()
-            for package in json.loads(
-                data,
-            ):
-                # Only append the filename once to the list of files
-                # as there's no way to download them separately through
-                # the API
-                filename = parse.unquote(package["file_name"])
-                if filename not in files:
-                    files.append(filename)
+        logger.debug("Listing package " + str(package_id) + " files")
+        path = "packages/" + parse.quote_plus(str(package_id)) + "/package_files"
+        data = self.gl_project_api(project, path)
+        for package in data:
+            # Only append the filename once to the list of files
+            # as there's no way to download them separately through
+            # the API
+            filename = parse.unquote(package["file_name"])
+            if filename not in files:
+                files.append(filename)
         return files
 
     def get_package_id(
         self, project: str, package_name: str, package_version: str
     ) -> int:
         id = 0
-        with request.urlopen(
-            request.Request(
-                self.project_api_url(project)
-                + "packages?package_name="
-                + parse.quote_plus(package_name)
-                + "&package_version="
-                + parse.quote_plus(package_version),
-                headers=self.get_headers(),
-            )
-        ) as res:
-            data = res.read()
-            package = json.loads(data)
-            if len(package) == 1:
-                package = package.pop()
-                id = package["id"]
+        logger.debug(
+            "Fetching package " + package_name + " (" + package_version + ") ID"
+        )
+        path = "packages"
+        arg = (
+            "package_name="
+            + parse.quote_plus(package_name)
+            + "&package_version="
+            + parse.quote_plus(package_version)
+        )
+        data = self.gl_project_api(project, path, arg)
+        if len(data) == 1:
+            package = data.pop()
+            id = package["id"]
         return id
 
     def download_file(
         self, project: str, package_name: str, package_version: str, file: str
     ) -> int:
         ret = 1
-        with request.urlopen(
-            request.Request(
-                self.project_api_url(project)
-                + "packages/generic/"
-                + parse.quote_plus(package_name)
-                + "/"
-                + parse.quote_plus(package_version)
-                + "/"
-                + parse.quote(str(file)),
-                headers=self.get_headers(),
-            )
-        ) as req:
+        logger.debug("Downloading file " + file)
+        url = (
+            self.project_api_url(project)
+            + "packages/generic/"
+            + parse.quote_plus(package_name)
+            + "/"
+            + parse.quote_plus(package_version)
+            + "/"
+            + parse.quote(str(file))
+        )
+        status, data, _ = self._request(url)
+        if status == 200:
             with open(str(file), "wb") as file:
-                file.write(req.read())
+                file.write(data)
                 ret = 0
         return ret
 
@@ -110,21 +142,22 @@ class Packages:
         self, project: str, package_name: str, package_version: str, file: str
     ) -> int:
         ret = 1
+        logger.debug("Uploading file " + file)
         with open(str(file), "rb") as data:
+            url = (
+                self.project_api_url(project)
+                + "packages/generic/"
+                + parse.quote_plus(package_name)
+                + "/"
+                + parse.quote_plus(package_version)
+                + "/"
+                + parse.quote(str(file))
+            )
             res = request.urlopen(
                 request.Request(
-                    self.project_api_url(project)
-                    + "packages/generic/"
-                    + parse.quote_plus(package_name)
-                    + "/"
-                    + parse.quote_plus(package_version)
-                    + "/"
-                    + parse.quote(str(file)),
-                    method="PUT",
-                    data=data,
-                    headers=self.get_headers(),
+                    url, method="PUT", data=data, headers=self.get_headers()
                 )
             )
-            if res.getcode() == 201:  # 201 is created
+            if res.status == 201:  # 201 is created
                 ret = 0
         return ret

{glpkg-0.0.1.dist-info → glpkg-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glpkg
-Version: 0.0.1
+Version: 1.1.0
 Summary: Tool to make GitLab generic package registry operations easy.
 Author-email: bugproduction <bugproduction@outlook.com>
 License-Expression: MIT
@@ -124,4 +124,3 @@ The tool is not perfect (yet) and has limitations. The following limitations are
 
 - Uploading files must be done one-by-one.
 - Only project registries are supported for now.
-- Pagination is not supported for now - in case you have more than 100 versions of a package, not all will be shown.

glpkg-1.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+gitlab/__init__.py,sha256=EsSFZxYgGAL2i0sL5zkoz71JP7XbsWdg_jv_uOqrrXE,60
+gitlab/__main__.py,sha256=88VNY5Qrmn8g0rNcnjKNdN746--0chHsKBMH3PD3Nao,177
+gitlab/cli_handler.py,sha256=6B22RXAtOzVL-mpm7U3OPX1_SSrepQk12cwTG0TI3eU,6102
+gitlab/packages.py,sha256=l9tFEUsHMWF0vtv5ouVB4nvmWrJ4KDaS6f5e1lpjNyk,5683
+glpkg-1.1.0.dist-info/licenses/LICENSE.md,sha256=josGXvZq628dNS0Iru58-DPE7dRpDXzjJxKKT35103g,1065
+glpkg-1.1.0.dist-info/METADATA,sha256=65URv9IMuUo1XnmqKolpuJ12nkjcFKJg8rKMz4XeUIQ,5500
+glpkg-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+glpkg-1.1.0.dist-info/entry_points.txt,sha256=xHPZwx2oShYDZ3AyH7WSIvuhFMssy7QLlQk-JAbje_w,46
+glpkg-1.1.0.dist-info/top_level.txt,sha256=MvIaP8p_Oaf4gO_hXmHkX-5y2deHLp1pe6tJR3ukQ6o,7
+glpkg-1.1.0.dist-info/RECORD,,

glpkg-0.0.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-gitlab/__init__.py,sha256=xA73jnLd2tGhd-9FwN86PRC0GscMytsHi3Sa6W-_WMk,60
-gitlab/__main__.py,sha256=88VNY5Qrmn8g0rNcnjKNdN746--0chHsKBMH3PD3Nao,177
-gitlab/cli_handler.py,sha256=kbbKMAxdTqeso_xSO5ZwmXI9ppGt0mABlxlqifkmaaM,5346
-gitlab/packages.py,sha256=Aw2Zt3Ok1uA9K8p8kugP3vizvcAxFMDaTQTwC-HH_sI,4431
-glpkg-0.0.1.dist-info/licenses/LICENSE.md,sha256=josGXvZq628dNS0Iru58-DPE7dRpDXzjJxKKT35103g,1065
-glpkg-0.0.1.dist-info/METADATA,sha256=IbfrEJtkS8OLW0W1VrfHnOlB8bdtpvGsUXSaun4YEOY,5617
-glpkg-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-glpkg-0.0.1.dist-info/entry_points.txt,sha256=xHPZwx2oShYDZ3AyH7WSIvuhFMssy7QLlQk-JAbje_w,46
-glpkg-0.0.1.dist-info/top_level.txt,sha256=MvIaP8p_Oaf4gO_hXmHkX-5y2deHLp1pe6tJR3ukQ6o,7
-glpkg-0.0.1.dist-info/RECORD,,