glpkg 1.0.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

gitlab/__init__.py

@@ -1,3 +1,3 @@
 from gitlab.packages import Packages
 
-__version__ = "1.0.0"
+__version__ = "1.2.0"

gitlab/cli_handler.py

@@ -1,6 +1,8 @@
 import argparse
 import netrc
 import os
+import sys
+import urllib
 from gitlab import Packages, __version__
 
 
@@ -33,7 +35,20 @@ class CLIHandler:
         return 0
 
     def do_it(self) -> int:
-        return self.args.action(self.args)
+        ret = 1
+        try:
+            ret = self.args.action(self.args)
+        except urllib.error.HTTPError as e:
+            # GitLab API returns 404 when a resource is not found
+            # but also when the user has no access to the resource
+            print("Oops! Something did go wrong.", file=sys.stderr)
+            print(e, file=sys.stderr)
+            print(
+                "Note that Error 404 may also indicate authentication issues with GitLab API.",
+                file=sys.stderr,
+            )
+            print("Check your arguments and credentials.", file=sys.stderr)
+        return ret
 
     def _register_common_arguments(self, parser) -> None:
         group = parser.add_mutually_exclusive_group()
@@ -73,6 +88,19 @@ class CLIHandler:
     def _register_download_parser(self, parser):
         self._register_common_arguments(parser)
         parser.add_argument("-v", "--version", type=str, help="The package version.")
+        parser.add_argument(
+            "-f",
+            "--file",
+            type=str,
+            help="The file to download from the package. If not defined, all files are downloaded.",
+        )
+        parser.add_argument(
+            "-d",
+            "--destination",
+            default="",
+            type=str,
+            help="The path where the file(s) are downloaded. If not defined, the current working directory is used.",
+        )
         parser.set_defaults(action=self._download_handler)
 
     def _args(self, args):
@@ -98,16 +126,25 @@ class CLIHandler:
         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
+        destination = args.destination
         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 = []
+            if args.file:
+                files.append(args.file)
+            else:
+                files = gitlab.list_files(project, package_id)
+            for file in files:
+                ret = gitlab.download_file(project, name, version, file, destination)
+                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):
@@ -134,9 +171,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,11 @@
+from http.client import HTTPMessage
 import json
+import logging
+import os
 from urllib import request, parse
 
+logger = logging.getLogger(__name__)
+
 
 class Packages:
     def __init__(self, host: str, token_type: str, token: str):
@@ -14,95 +19,135 @@ 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
+        self,
+        project: str,
+        package_name: str,
+        package_version: str,
+        filename: str,
+        destination: 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:
-            with open(str(file), "wb") as file:
-                file.write(req.read())
+        logger.debug("Downloading file " + filename)
+        url = (
+            self.project_api_url(project)
+            + "packages/generic/"
+            + parse.quote_plus(package_name)
+            + "/"
+            + parse.quote_plus(package_version)
+            + "/"
+            + parse.quote(filename)
+        )
+        status, data, _ = self._request(url)
+        if status == 200:
+            path = os.path.join(destination, filename)
+            parent = os.path.dirname(path)
+            if parent:
+                # Create missing directories if needed
+                # In case path has no parent, current
+                # workind directory is used
+                os.makedirs(os.path.dirname(path), exist_ok=True)
+            with open(path, "wb") as file:
+                file.write(data)
                 ret = 0
         return ret
 
@@ -110,21 +155,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-1.0.0.dist-info → glpkg-1.2.0.dist-info}/METADATA

@@ -1,25 +1,19 @@
 Metadata-Version: 2.4
 Name: glpkg
-Version: 1.0.0
+Version: 1.2.0
 Summary: Tool to make GitLab generic package registry operations easy.
 Author-email: bugproduction <bugproduction@outlook.com>
 License-Expression: MIT
 Project-URL: Repository, https://gitlab.com/bugproduction/glpkg.git
 Keywords: GitLab,packages,registry,generic
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: setuptools; extra == "dev"
-Requires-Dist: twine; extra == "dev"
 Dynamic: license-file
 
-# glpkg - GitLab Generic Package registry tools 
+# glpkg - GitLab Generic Package tools 
 
-glpkg is a tool that makes it easy to work with [GitLab generic package registry](https://docs.gitlab.com/user/packages/generic_packages/).
+glpkg is a tool that makes it easy to work with [GitLab generic packages](https://docs.gitlab.com/user/packages/generic_packages/).
 
 
 ## Installation
@@ -47,7 +41,11 @@ By default, the used GitLab host is gitlab.com. If you use a self-hosted GitLab,
 
 To authenticate with the package registry in any of the commands below, use `--token readapitoken123` argument where the `readapitoken123` is a [personal](https://docs.gitlab.com/user/profile/personal_access_tokens/#create-a-personal-access-token) or [project](https://docs.gitlab.com/user/project/settings/project_access_tokens/#create-a-project-access-token) access token, with read API scope. In case the package registry is public, you can omit this argument.
 
-The above arguments are omitted in the examples below to focus on the functions. Add the arguments to change the host or to authenticate with the registry.
+Alternatively you can use a token stored in your `.netrc` file by setting `--netrc` argument.
+
+> If you use the tool in GitLab CI, read [below](#Use-in-GitLab-pipelines) on how to use the `CI_JOB_TOKEN`.
+
+The arguments related to the GitLab host or authentication (`--token`, `--netrc`, and `--ci`) are omitted in the examples below to focus on the commands.
 
 In general, run `glpkg --help` when needed.
 
@@ -74,7 +72,7 @@ mypackagename   2.0
 
 ### Download generic package
 
-To download everything from a specific generic package, run
+To download all files from a specific version of a generic package, run
 
 ```bash
 glpkg download --project 12345 --name mypackagename --version 1.0
@@ -85,7 +83,13 @@ Where:
 - `mypackagename` is the name of the generic package
 - `1.0` is the version of the generic package from which the files are downloaded
 
-The files will be downloaded in the current working directory. Any pre-existing files will be overridden without warning.
+By default the files will be downloaded in the current working directory. To download the files to another directory, add argument `--destination` to the command. In all cases, as long as you have permissions to the destination directory, any pre-existing files will be overridden without warning.
+
+To download only a specific file from the package, add `--file` argument.
+
+```bash
+glpkg download --project 12345 --name mypackagename --version 1.5 --file the_only_one --destination /temp
+```
 
 > If a package has multiple files with the same filename, the tool can only download the newest file. This is a restriction of GitLab API.
 
@@ -107,7 +111,7 @@ Where:
 
 ### Use in GitLab pipelines
 
-If you use the tool in a GitLab pipeline, using `--ci` argument uses [GitLab predefined variables](https://docs.gitlab.com/ci/variables/predefined_variables/) to configure the tool. In this case `CI_SERVER_HOST`, `CI_PROJECT_ID`, and `CI_JOB_TOKEN` environment variables are used. The `--project`, and `--token` arguments can still be used to override the project ID and to use a personal or project access token instead of CI_JOB_TOKEN.
+If you use the tool in a GitLab pipeline, setting argument `--ci` uses [GitLab predefined variables](https://docs.gitlab.com/ci/variables/predefined_variables/) to configure the tool. In this case `CI_SERVER_HOST`, `CI_PROJECT_ID`, and `CI_JOB_TOKEN` environment variables are used. The `--project`, and `--token` arguments can still be used to override the project ID or to use a personal or project access token instead of `CI_JOB_TOKEN`.
 
 In other words, you don't need to give the `--host`, `--project`, or `--token` arguments if you are interacting with the package registry of the project where the pipeline is running. Example: uploading `my-file.txt` to generic package `mypackagename` version `1.0` in the project package registry in CI:
 
@@ -124,4 +128,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.2.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+gitlab/__init__.py,sha256=U83zG_KkowpY9GMPLmmySx5fyNx52nojUJkfIpzMo5o,60
+gitlab/__main__.py,sha256=88VNY5Qrmn8g0rNcnjKNdN746--0chHsKBMH3PD3Nao,177
+gitlab/cli_handler.py,sha256=RKEEcbxFCFkT8sbYDlMXuQPM4wvCb0okBiFfUXXlJtg,7314
+gitlab/packages.py,sha256=8w5bc5I03dEqkMcLydqtgQ9UN2SJWw7MlkjnJXp6fmA,6099
+glpkg-1.2.0.dist-info/licenses/LICENSE.md,sha256=josGXvZq628dNS0Iru58-DPE7dRpDXzjJxKKT35103g,1065
+glpkg-1.2.0.dist-info/METADATA,sha256=cVhMx6Gt_Nx1RkXNeetlu8f7__dkO5y1c2jOncFlZT8,5841
+glpkg-1.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+glpkg-1.2.0.dist-info/entry_points.txt,sha256=xHPZwx2oShYDZ3AyH7WSIvuhFMssy7QLlQk-JAbje_w,46
+glpkg-1.2.0.dist-info/top_level.txt,sha256=MvIaP8p_Oaf4gO_hXmHkX-5y2deHLp1pe6tJR3ukQ6o,7
+glpkg-1.2.0.dist-info/RECORD,,

glpkg-1.0.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-gitlab/__init__.py,sha256=BswgrGAgPCau63NFj5mRmAZRbCxBOyZ_sKX1YiLNTxA,60
-gitlab/__main__.py,sha256=88VNY5Qrmn8g0rNcnjKNdN746--0chHsKBMH3PD3Nao,177
-gitlab/cli_handler.py,sha256=xiLRqA33E0LdvuBSRW8Zn8O_chZX3-tY5umAitCue6Y,5786
-gitlab/packages.py,sha256=Aw2Zt3Ok1uA9K8p8kugP3vizvcAxFMDaTQTwC-HH_sI,4431
-glpkg-1.0.0.dist-info/licenses/LICENSE.md,sha256=josGXvZq628dNS0Iru58-DPE7dRpDXzjJxKKT35103g,1065
-glpkg-1.0.0.dist-info/METADATA,sha256=ujT2mqVYwD0aL9MH45jRwBG9qi8eHgwoiis9X2zzAdI,5617
-glpkg-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-glpkg-1.0.0.dist-info/entry_points.txt,sha256=xHPZwx2oShYDZ3AyH7WSIvuhFMssy7QLlQk-JAbje_w,46
-glpkg-1.0.0.dist-info/top_level.txt,sha256=MvIaP8p_Oaf4gO_hXmHkX-5y2deHLp1pe6tJR3ukQ6o,7
-glpkg-1.0.0.dist-info/RECORD,,