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

gitlab/__init__.py

@@ -1,3 +1,5 @@
+"""GitLab packages initialization module"""
+
 from gitlab.packages import Packages
 
-__version__ = "1.2.0"
+__version__ = "1.4.0"

gitlab/__main__.py

@@ -1,9 +1,26 @@
+"""GitLab packages main module"""
+
+import logging
 import sys
 
 from gitlab.cli_handler import CLIHandler
 
 
 def cli() -> int:
+    """
+    Runs the main program of the glpkg.
+
+    Uses arguments from command line and executes the given command.
+
+    Return
+    ------
+    int
+        Zero when everything is fine, non-zero otherwise.
+    """
+    logging.basicConfig(
+        level=logging.DEBUG,
+        handlers=[logging.FileHandler("glpkg.log")],  # , logging.StreamHandler()],
+    )
     handler = CLIHandler()
     return handler.do_it()
 

gitlab/cli_handler.py

@@ -1,5 +1,7 @@
+"""CLI handler for glpkg"""
+
 import argparse
-import netrc
+from netrc import netrc
 import os
 import sys
 import urllib
@@ -7,7 +9,15 @@ from gitlab import Packages, __version__
 
 
 class CLIHandler:
+    """Class to parse CLI arguments and run the requested command"""
+
     def __init__(self):
+        """
+        Creates a new instance of CLIHandler.
+
+        Parses the arguments from command line and prepares everything
+        to be ready to executed. Just use do_it to run it!
+        """
         parser = argparse.ArgumentParser(
             description="Toolbox for GitLab generic packages"
         )
@@ -16,25 +26,57 @@ class CLIHandler:
         subparsers = parser.add_subparsers()
         list_parser = subparsers.add_parser(
             name="list",
-            description="Lists the available version of a package from the package registry.",
+            description="Lists the available version of a package from the "
+            "package registry.",
         )
         self._register_list_parser(list_parser)
         download_parser = subparsers.add_parser(
             name="download",
-            description="Downloads all files from a specific package version to the current directory.",
+            description="Downloads all files from a specific package version "
+            "to the current directory.",
         )
         self._register_download_parser(download_parser)
         upload_parser = subparsers.add_parser(
             name="upload", description="Uploads file to a specific package version."
         )
         self._register_upload_parser(upload_parser)
+        delete_parser = subparsers.add_parser(
+            name="delete",
+            description="Deletes a specific package version or a specific file from "
+            "a specific package version, depending whether the --file argument is "
+            "set or not.",
+        )
+        self._register_delete_parser(delete_parser)
         self.args = parser.parse_args()
 
-    def _print_version(self, args) -> int:
+    def _print_version(self, _args: argparse.Namespace) -> int:
+        """
+        A handler for printing the version of the tool to the console.
+
+        Parameters
+        ----------
+        _args : argparse.Namespace
+            Unused.
+
+        Return
+        ------
+        int
+            Zero when printing to console succeeded.
+        """
         print(__version__)
         return 0
 
     def do_it(self) -> int:
+        """
+        Executes the requested command.
+
+        In case of error, prints to stderr.
+
+        Return
+        ------
+        int
+            Zero when everything went fine, non-zero otherwise.
+        """
         ret = 1
         try:
             ret = self.args.action(self.args)
@@ -50,20 +92,38 @@ class CLIHandler:
             print("Check your arguments and credentials.", file=sys.stderr)
         return ret
 
-    def _register_common_arguments(self, parser) -> None:
+    def _register_common_arguments(self, parser: argparse.ArgumentParser) -> None:
+        """
+        Registers common arguments to the parser:
+            - host
+            - ci
+            - project
+            - name
+            - token
+            - netrc
+
+        Parameters
+        ----------
+        parser:
+            The argparser where to register the common arguments.
+        """
         group = parser.add_mutually_exclusive_group()
         group.add_argument(
             "-H",
             "--host",
             default="gitlab.com",
             type=str,
-            help="The host address of GitLab instance without scheme, for example gitlab.com. Note that only https scheme is supported.",
+            help="The host address of GitLab instance without scheme, "
+            "for example gitlab.com. Note that only https scheme is supported.",
         )
         group.add_argument(
             "-c",
             "--ci",
             action="store_true",
-            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.",
+            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",
@@ -77,33 +137,77 @@ class CLIHandler:
             "-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.",
+            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.",
+            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):
+    def _register_download_parser(self, parser: argparse.ArgumentParser):
+        """
+        Registers the download command related arguments to the parser:
+            - version
+            - file
+            - destination
+            - action
+
+        Additionally, registers the common args.
+
+        Parameters
+        ----------
+        parser:
+            The argparser where to register the download arguments.
+        """
         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.",
+            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.",
+            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):
+    def _args(self, args) -> tuple[str, str, str, str, str]:
+        """
+        Returns the connection parameters according to the args
+
+        Parameters
+        ----------
+        args:
+            The args that are used to determined the connection parameters
+
+        Returns
+        -------
+        host : str
+            The GitLab host name
+        project : str
+            The Project ID or name to use
+        name : str
+            The package name
+        token_user : str
+            The token user according to the args. If ci is used, returns `JOB-TOKEN`, else
+            `PRIVATE-TOKEN`.
+        token : str
+            The token according to the args. If token is set, returns it. If netrc is set,
+            reads the token from the .netrc file. If ci is set, reads the environment
+            variable CI_JOB_TOKEN. Otherwise returns None.
+        """
         if args.ci:
             host = os.environ["CI_SERVER_HOST"]
             project = os.environ["CI_PROJECT_ID"]
@@ -120,26 +224,39 @@ class CLIHandler:
             token = args.token
             token_user = "PRIVATE-TOKEN"
         if args.netrc:
-            _, _, token = netrc.netrc().authenticators(host)
+            _, _, token = netrc().authenticators(host)
             token_user = "PRIVATE-TOKEN"
         name = args.name
         return host, project, name, token_user, token
 
-    def _download_handler(self, args) -> int:
+    def _download_handler(self, args: argparse.Namespace) -> int:
+        """
+        Downloads package file(s) from GitLab package registry.
+
+        Parameters
+        ----------
+        args : argparse.Namespace
+            The parsed arguments
+
+        Returns
+        -------
+        int
+            Zero if everything goes well, non-zero otherwise
+        """
         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)
+        packages = Packages(host, token_user, token)
+        package_id = packages.get_id(project, name, version)
         if package_id:
             files = []
             if args.file:
                 files.append(args.file)
             else:
-                files = gitlab.list_files(project, package_id)
+                files = packages.get_files(project, package_id).keys()
             for file in files:
-                ret = gitlab.download_file(project, name, version, file, destination)
+                ret = packages.download_file(project, name, version, file, destination)
                 if ret:
                     print("Failed to download file " + file)
                     break
@@ -147,37 +264,156 @@ class CLIHandler:
             print("No package " + name + " version " + version + " found!")
         return ret
 
-    def _register_list_parser(self, parser):
+    def _register_list_parser(self, parser: argparse.ArgumentParser):
+        """
+        Registers the list command related arguments to the parser:
+            - action
+
+        Additionally, registers the common args.
+
+        Parameters
+        ----------
+        parser:
+            The argparser where to register the list arguments.
+        """
         self._register_common_arguments(parser)
         parser.set_defaults(action=self._list_packages)
 
     def _list_packages(self, args: argparse.Namespace) -> int:
+        """
+        List package versions from GitLab package registry.
+
+        Parameters
+        ----------
+        args : argparse.Namespace
+            The parsed arguments
+
+        Returns
+        -------
+        int
+            Zero if everything goes well, non-zero otherwise
+        """
         host, project, name, token_user, token = self._args(args)
-        gitlab = Packages(host, token_user, token)
-        packages = gitlab.list_packages(project, name)
+        packages = Packages(host, token_user, token)
+        package_list = packages.get_versions(project, name)
         print("Name" + "\t\t" + "Version")
-        for package in packages:
+        for package in package_list:
             print(package["name"] + "\t" + package["version"])
 
-    def _register_upload_parser(self, parser):
+    def _register_upload_parser(self, parser: argparse.ArgumentParser):
+        """
+        Registers the upload command related arguments to the parser:
+            - version
+            - file
+            - action
+
+        Additionally, registers the common args.
+
+        Parameters
+        ----------
+        parser:
+            The argparser where to register the upload arguments.
+        """
         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 be uploaded, for example my_file.txt. Note that only relative paths are supported and the relative path is preserved when uploading the file.",
+            help="The file to be uploaded, for example my_file.txt. Note that "
+            "only relative paths (to the source) are supported and the relative "
+            "path is preserved when uploading the file. If left undefined, all files "
+            "of the source directory are uploaded. For example --source=temp --file=myfile "
+            "will upload myfile to the GitLab generic package root. However using --source=. "
+            "(or omittinge source) --file=temp/myfile will upload the file to temp folder "
+            "in the GitLab package.",
+        )
+        parser.add_argument(
+            "-s",
+            "--source",
+            type=str,
+            default="",
+            help="The source directory of the uploaded file(s). Defaults to current"
+            "working directory.",
         )
         parser.set_defaults(action=self._upload)
 
-    def _upload(self, args) -> int:
-        ret = 1
+    def _upload(self, args: argparse.Namespace) -> int:
+        """
+        Uploads a file to a GitLab package registry
+
+        Parameters
+        ----------
+        args : argparse.Namespace
+            The arguments from command line
+
+        Returns
+        -------
+        int
+            Zero if everything went fine, non-zero otherwise.
+        """
+        ret = 0
+        host, project, name, token_user, token = self._args(args)
+        version = args.version
+        file = args.file
+        source = args.source
+        if file:
+            # Check if the uploaded file exists.
+            if not os.path.isfile(os.path.join(source, file)):
+                print("File " + file + " does not exist!")
+                ret = 1
+        if not ret:
+            packages = Packages(host, token_user, token)
+            ret = packages.upload_file(project, name, version, file, source)
+        return ret
+
+    def _register_delete_parser(self, parser: argparse.ArgumentParser):
+        """
+        Registers the delete command related arguments to the parser:
+            - version
+            - file
+            - action
+
+        Additionally, registers the common args.
+
+        Parameters
+        ----------
+        parser:
+            The argparser where to register the upload arguments.
+        """
+        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 be deleted, for example my_file.txt. Note that "
+            "only relative paths (to the package root) are supported. If undefined, "
+            "the package version is deleted.",
+        )
+        parser.set_defaults(action=self._delete)
+
+    def _delete(self, args: argparse.Namespace) -> int:
+        """
+        Deletes a file from a GitLab generic package
+
+        Parameters
+        ----------
+        args : argparse.Namespace
+            The arguments from command line
+
+        Returns
+        -------
+        int
+            Zero if everything went fine, non-zero otherwise.
+        """
+        ret = 0
         host, project, name, token_user, token = self._args(args)
         version = args.version
         file = args.file
-        if os.path.isfile(file):
-            gitlab = Packages(host, token_user, token)
-            ret = gitlab.upload_file(project, name, version, file)
+        packages = Packages(host, token_user, token)
+        if file:
+            ret = packages.delete_file(project, name, version, file)
         else:
-            print("File " + file + " does not exist!")
+            ret = packages.delete_package(project, name, version)
         return ret

gitlab/packages.py

@@ -1,5 +1,8 @@
+"""GitLab generic packages module"""
+
+from glob import glob
 from http.client import HTTPMessage
-import json
+from json import loads
 import logging
 import os
 from urllib import request, parse
@@ -8,71 +11,298 @@ logger = logging.getLogger(__name__)
 
 
 class Packages:
+    """Class to interact with GitLab packages REST API"""
+
     def __init__(self, host: str, token_type: str, token: str):
+        """
+        Creates a new instance of class.
+
+        Parameters
+        ----------
+        host : str
+            The GitLab instance hostname, without schema.
+            The host will be used for the package API interaction.
+            For example gitlab.com.
+        token_type : str
+            The token type or "user" to authenticate with GitLab REST API.
+            For personal, project, and group tokens this is `PRIVATE-TOKEN`.
+            For `CI_JOB_TOKEN` this is `JOB-TOKEN`.
+            Can be left empty when authentication is not used.
+        token : str
+            The token (secret) to authenticate with GitLab REST API.
+            This can be a personal token, project token, or`CI_JOB_TOKEN`.
+            Leave empty when authentication is not used.
+        """
         self.host = host
         self.token_type = token_type
         self.token = token
 
-    def api_url(self) -> str:
-        return "https://{}/api/v4/".format(parse.quote(self.host))
+    def _url(self) -> str:
+        """
+        Returns the GitLab REST API URL by using the host variable.
 
-    def project_api_url(self, project: str) -> str:
-        return self.api_url() + "projects/{}/".format(parse.quote_plus(project))
+        Returns
+        -------
+        str
+            The GitLab REST API URL, for example `https://gitlab.com/api/v4/`.
+        """
+        return f"https://{self.host}/api/v4/"
 
-    def get_headers(self) -> dict:
+    def _get_headers(self) -> dict:
+        """
+        Creates headers for a GitLab REST API call.
+
+        The headers contain token for authentication according to the
+        instance variables.
+
+        Returns
+        -------
+        dict
+            Headers for a REST API request, that contain the authentication token.
+        """
         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 _parse_header_links(self, headers: HTTPMessage) -> dict:
+        """
+        Parses link field from HTTP headers to a dictionary where
+        the link "rel" value is the key.
 
-    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
+        This is useful for example with GitLab REST API to get the pagination links.
+
+        Parameters
+        ----------
+        headers : HTTPMessage
+            The HTTP response headers that contain the links
+
+        Returns
+        -------
+        dict
+            The header links in a dictionary, that can be used to for example pagination:
+            _parse_header_links(headers).get("next") returns the next page link, or None.
+        """
+        links = {}
+        header_links = headers.get("link")
+        if header_links:
+            items = header_links.split(",")
+            # Values are <uri-reference>; param1=value1; param2="value2"
+            for item in items:
+                parts = item.split(";", 1)
+                if parts:
+                    # First value should be the URI
+                    val = parts.pop(0).lstrip(" <").rstrip("> ")
+                    # The rest are the parameters; let's take the first one that has rel=
+                    # in it, split it with ; and take the first part as a value
+                    typ = parts.pop()
+                    typ = typ.split("rel=", 1).pop().split(";").pop(0).strip('" ')
+                    links[typ] = val
+        return links
+
+    def _build_path(self, *paths: str) -> str:
+        """
+        Returns the path to be appended to the REST API URL
+
+        Parameters
+        ----------
+        paths : str
+            The path string that are joined with "/".
 
-    def _build_query(self, arg: str, page: int) -> str:
+        Returns
+        -------
+        str
+            A URL path, for example `projects/123/`
+            or `projects/namespace%2Fproject/`
+        """
+        quoted_paths = []
+        for subpath in paths:
+            quoted_paths.append(subpath)
+        return "/".join(quoted_paths)
+
+    def build_query(self, **args: str) -> str:
+        """
+        Builds a query for a GitLab REST API request
+
+        Parameters
+        ----------
+        args : str
+            keyword arguments for the REST API query, like per_page=20, page=20
+
+        Returns
+        -------
+        str
+            A query string for a REST API request. Append this to
+            the request URL. Example `?per_page=20&page=20`.
+        """
         query = ""
-        if arg or page:
-            if page:
-                page = "page=" + str(page)
-            query = "?{}".format("&".join(filter(None, (arg, page))))
+        for key, value in args.items():
+            query = "&".join(filter(None, (query, f"{key}={parse.quote_plus(value)}")))
+        if query:
+            query = "?" + query
         return query
 
-    def gl_project_api(self, project: str, path: str, arg: str = None) -> list:
+    def _get(self, url: str, headers: dict) -> tuple[int, bytes, HTTPMessage]:
+        """
+        Makes a raw GET request to the given URL, and returns
+        the response status, body, and headers.
+
+        Parameters
+        ----------
+        url : str
+            The URL of the HTTP request to make.
+        headers: dict
+            The HTTP headers used in the request.
+
+        Returns
+        -------
+        int
+            The HTTP response code, such as 200
+        bytes
+            The HTTP response body read as bytes
+        HTTPMessage
+            The HTTP response headers
+        """
+        logger.debug("Getting %s", url)
+        req = request.Request(url, headers=headers)
+        with request.urlopen(req) as response:
+            return response.status, response.read(), response.headers
+
+    def get(self, *paths: str, **query_params: str) -> tuple[int, bytes, HTTPMessage]:
+        """
+        Makes a HTTP GET request to the given GitLab path, and returns
+        the response status, body, and headers.
+
+        Parameters
+        ----------
+        paths : str
+            The URL path of the HTTP request to make.
+        query_params : str,  optional
+            Dictionary of query parameters for the request, like package_name=mypackage
+
+        Returns
+        -------
+        int
+            The HTTP response code, such as 200
+        bytes
+            The HTTP response body read as bytes
+        HTTPMessage
+            The HTTP response headers
+        """
+        url = self._url() + self._build_path(*paths) + self.build_query(**query_params)
+        headers = self._get_headers()
+        return self._get(url, headers)
+
+    def get_all(self, *paths: str, **query_params: str) -> list:
+        """
+        Returns data from the REST API endpoint. In case
+        of multiple pages, all data will be returned.
+
+        Parameters
+        ----------
+        paths : str
+            The paths of the API endpoint that is called. For example projects, 123, packages
+            would be querying the projects/123/packages endpoint.
+        query_params : str, optional
+            Additional arguments for the query of the URL, for example to filter
+            results: package_name=mypackage
+
+        Returns
+        -------
+        list
+            Data from GitLab REST API endpoint with the arguments.
+        """
+        url = self._url() + self._build_path(*paths) + self.build_query(**query_params)
         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))
+        while url:
+            res_status, res_data, res_headers = self._get(url, self._get_headers())
+            logger.debug("Response status: %d", res_status)
+            res_data = loads(res_data)
+            logger.debug("Response data: %s", res_data)
             data = data + res_data
-            page = self._get_next_page(headers)
-            if page:
-                more = True
+            url = self._parse_header_links(res_headers).get("next")
         return data
 
-    def list_packages(self, project: str, package_name: str) -> list:
+    def put(self, data: bytes, *paths: str, **query_params: str) -> int:
+        """
+        Makes a HTTP PUT request to the given GitLab path.
+
+        Parameters
+        ----------
+        data : bytes
+            The data to PUT.
+        paths : str
+            The URL path of the HTTP request to make.
+        query_params : str, optional
+            Additional arguments for the query of the URL, for example to filter
+            results: package_name=mypackage
+
+        Returns
+        -------
+        int
+            0 If the request was successful.
+        """
+        ret = 1
+        url = self._url() + self._build_path(*paths) + self.build_query(**query_params)
+        logger.debug("Putting %s", url)
+        req = request.Request(url, method="PUT", data=data, headers=self._get_headers())
+        with request.urlopen(req) as res:
+            if res.status == 201:  # 201 is created
+                ret = 0
+        return ret
+
+    def delete(self, *paths: str, **query_params: str) -> int:
+        """
+        Makes a HTTP DELETE request to the given GitLab path.
+
+        Parameters
+        ----------
+        paths : str
+            The URL path of the HTTP request to make.
+        query_params : str, optional
+            Additional arguments for the query of the URL, for example to filter
+            results: package_name=mypackage
+
+        Returns
+        -------
+        int
+            0 If the request was successful.
+        """
+        ret = 1
+        url = self._url() + self._build_path(*paths) + self.build_query(**query_params)
+        logger.debug("Deleting %s", url)
+        req = request.Request(url, method="DELETE", headers=self._get_headers())
+        with request.urlopen(req) as res:
+            if res.status == 204:
+                # 204 is no content, that GL responds when file deleted
+                ret = 0
+        return ret
+
+    def get_versions(self, project_id: str, package_name: str) -> list:
+        """
+        Lists the available versions of the package
+
+        Parameters
+        ----------
+        project_id : str
+            The project ID or path, including namespace.
+            Examples: `123` or `namespace/project`.
+        package_name : str
+            The name of the package that is listed.
+
+        Returns
+        -------
+        list
+            List of {package: name, version: version} that are available.
+        """
         packages = []
-        logger.debug("Listing packages with name " + package_name)
-        data = self.gl_project_api(
-            project, "packages", "package_name=" + parse.quote_plus(package_name)
+        logger.debug("Listing packages with name %s", package_name)
+        data = self.get_all(
+            "projects",
+            parse.quote_plus(project_id),
+            "packages",
+            package_name=package_name,
+            package_type="generic",
         )
         for package in data:
             name = parse.unquote(package["name"])
@@ -84,93 +314,310 @@ class Packages:
             packages.append({"name": name, "version": version})
         return packages
 
-    def list_files(self, project: str, package_id: int) -> list:
-        files = []
-        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)
+    def get_files(self, project_id: str, package_id: int) -> dict:
+        """
+        Lists all files of a specific package ID from GitLab REST API
+
+        Parameters
+        ----------
+        project_id : str
+            The project ID or path, including namespace.
+            Examples: `123` or `namespace/project`.
+        package_id : int
+            The package ID that is listed
+
+        Return
+        ------
+        dict
+            Dictionary of file (names) that are in the package, with
+            each element containing a dictionary containing information
+            of the file
+        """
+        files = {}
+        logger.debug("Listing package %d files", package_id)
+        data = self.get_all(
+            "projects",
+            parse.quote_plus(project_id),
+            "packages",
+            str(package_id),
+            "package_files",
+        )
         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)
+            file_id = package["id"]
+            if not files.get(filename):
+                files[filename] = {"id": file_id}
         return files
 
-    def get_package_id(
-        self, project: str, package_name: str, package_version: str
-    ) -> int:
-        id = 0
-        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)
+    def get_id(self, project_id: str, package_name: str, package_version: str) -> int:
+        """
+        Gets the package ID of a specific package version.
+
+        Parameters
+        ----------
+        project_id : str
+            The project ID or path, including namespace.
+            Examples: `123` or `namespace/project`.
+        package_name : str
+            The name of the package.
+        package_version : str
+            The version of the package
+
+        Return
+        ------
+        int
+            The ID of the package. -1 if no ID was found.
+        """
+        package_id = -1
+        logger.debug("Fetching package %s (%s) ID", package_name, package_version)
+        data = self.get_all(
+            "projects",
+            parse.quote_plus(project_id),
+            "packages",
+            package_name=package_name,
+            package_version=package_version,
+            package_type="generic",
         )
-        data = self.gl_project_api(project, path, arg)
         if len(data) == 1:
             package = data.pop()
-            id = package["id"]
-        return id
+            package_id = package["id"]
+        return package_id
 
     def download_file(
         self,
-        project: str,
+        project_id: str,
         package_name: str,
         package_version: str,
         filename: str,
         destination: str = "",
     ) -> int:
+        """
+        Downloads a file from a GitLab generic package
+
+        Parameters
+        ----------
+        project_id : str
+            The project ID or path, including namespace.
+            Examples: `123` or `namespace/project`.
+        package_name : str
+            The name of the generic package.
+        package_version : str
+            The version of the generic package
+        filename : str
+            The file that is downloaded
+        destination : str, optional
+            The destination folder of the downloaded file. If not set,
+            current working directory is used.
+
+        Return
+        ------
+        int
+            Zero if everything went fine, non-zero coke otherwise.
+        """
         ret = 1
-        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)
+        logger.debug("Downloading file %s", filename)
+        status, data, _ = self.get(
+            "projects",
+            parse.quote_plus(project_id),
+            "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)
+            fpath = os.path.join(destination, filename)
+            parent = os.path.dirname(fpath)
             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:
+                os.makedirs(os.path.dirname(fpath), exist_ok=True)
+            with open(fpath, "wb") as file:
                 file.write(data)
                 ret = 0
         return ret
 
     def upload_file(
-        self, project: str, package_name: str, package_version: str, file: str
+        self,
+        project_id: str,
+        package_name: str,
+        package_version: str,
+        filename: str,
+        source: str,
     ) -> int:
+        """
+        Uploads file(s) to a GitLab generic package.
+
+        Parameters
+        ----------
+        project_id : str
+            The project ID or path, including namespace.
+            Examples: `123` or `namespace/project`.
+        package_name : str
+            The name of the generic package.
+        package_version : str
+            The version of the generic package
+        pfile : str
+            The relative path of the file that is uploaded. If left empty,
+            all files from the source folder, and it's subfolders, are uploaded.
+        source : str
+            The source folder that is used as root when uploading. If empty,
+            current working directory is used.
+
+        Return
+        ------
+        int
+            Zero if everything went fine, non-zero coke otherwise.
+        """
+        files = []
         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))
+        if filename:
+            files.append(filename)
+        else:
+            filelist = glob(os.path.join(source, "**"), recursive=True)
+            for item in filelist:
+                # Only add files, not folders
+                if os.path.isfile(os.path.join(item)):
+                    # Remove the source folder from the path of the files
+                    files.append(os.path.relpath(item, source))
+        for afile in files:
+            ret = self._upload_file(
+                project_id, package_name, package_version, afile, source
             )
-            res = request.urlopen(
-                request.Request(
-                    url, method="PUT", data=data, headers=self.get_headers()
-                )
+            if ret:
+                break
+        return ret
+
+    def _upload_file(
+        self,
+        project_id: str,
+        package_name: str,
+        package_version: str,
+        filename: str,
+        source: str,
+    ) -> int:
+        """
+        Uploads a file to a GitLab generic package.
+
+        Parameters
+        ----------
+        project_id : str
+            The project ID or path, including namespace.
+            Examples: `123` or `namespace/project`.
+        package_name : str
+            The name of the generic package.
+        package_version : str
+            The version of the generic package
+        filename : str
+            The relative path of the file that is uploaded.
+        source : str
+            The source folder that is used as root when uploading.
+
+        Return
+        ------
+        int
+            Zero if everything went fine, non-zero coke otherwise.
+        """
+        ret = 1
+        fpath = os.path.join(source, filename)
+        logger.debug("Uploading file %s from %s", filename, source)
+        with open(fpath, "rb") as data:
+            ret = self.put(
+                data.read(),
+                "projects",
+                parse.quote_plus(project_id),
+                "packages",
+                "generic",
+                parse.quote_plus(package_name),
+                parse.quote_plus(package_version),
+                parse.quote(filename),
             )
-            if res.status == 201:  # 201 is created
-                ret = 0
+        return ret
+
+    def delete_package(
+        self, project_id: str, package_name: str, package_version: str
+    ) -> int:
+        """
+        Deletes a version of a GitLab generic package.
+
+        Parameters
+        ----------
+        project_id : str
+            The project ID or path, including namespace.
+            Examples: `123` or `namespace/project`.
+        package_name : str
+            The name of the generic package.
+        package_version : str
+            The version of the generic package that is deleted
+
+        Return
+        ------
+        int
+            Zero if everything went fine, non-zero coke otherwise.
+        """
+        ret = 1
+        package_id = self.get_id(project_id, package_name, package_version)
+        if package_id > 0:
+            ret = self.delete(
+                "projects", parse.quote_plus(project_id), "packages", str(package_id)
+            )
+        return ret
+
+    def delete_file(
+        self,
+        project_id: str,
+        package_name: str,
+        package_version: str,
+        filename: str,
+    ) -> int:
+        """
+        Deletes a file from a GitLab generic package.
+
+        Parameters
+        ----------
+        project_id : str
+            The project ID or path, including namespace.
+            Examples: `123` or `namespace/project`.
+        package_name : str
+            The name of the generic package.
+        package_version : str
+            The version of the generic package
+        filename : str
+            The path of the file to be deleted in the package.
+
+        Return
+        ------
+        int
+            Zero if everything went fine, non-zero coke otherwise.
+        """
+        ret = 1
+        package_id = self.get_id(project_id, package_name, package_version)
+        if package_id > 0:
+            package_files = self.get_files(project_id, package_id)
+            file_id = package_files.get(filename)
+            if file_id and file_id.get("id"):
+                file_id = file_id.get("id")
+                ret = self._delete_file(project_id, package_id, file_id)
+        return ret
+
+    def _delete_file(self, project_id: str, package_id: int, file_id: int) -> int:
+        ret = 1
+        logger.info(
+            "Deleting file %d from package %d from project %s",
+            file_id,
+            package_id,
+            project_id,
+        )
+        ret = self.delete(
+            "projects",
+            parse.quote_plus(project_id),
+            "packages",
+            str(package_id),
+            "package_files",
+            str(file_id),
+        )
         return ret

{glpkg-1.2.0.dist-info → glpkg-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glpkg
-Version: 1.2.0
+Version: 1.4.0
 Summary: Tool to make GitLab generic package registry operations easy.
 Author-email: bugproduction <bugproduction@outlook.com>
 License-Expression: MIT
@@ -15,6 +15,7 @@ Dynamic: license-file
 
 glpkg is a tool that makes it easy to work with [GitLab generic packages](https://docs.gitlab.com/user/packages/generic_packages/).
 
+Generic package registries of GitLab projects are supported. Group registries are not, as the GitLab REST API for groups is very limited.
 
 ## Installation
 
@@ -26,7 +27,6 @@ pip install glpkg
 
 To check the installation and version,  run:
 
-
 ```bash
 glpkg --version
 ```
@@ -105,10 +105,49 @@ Where:
 - `12345` is your projects ID ([Find the Project ID](https://docs.gitlab.com/user/project/working_with_projects/#find-the-project-id)) or the path of the project (like `namespace/project`)
 - `mypackagename` is the name of the generic package
 - `1.0` is the version of the generic package to which the file is uploaded
-- `my-file.txt` is the file that is uploaded to the generic package. Currently, only relative paths are supported, and the relative path (e.g. `folder/file.txt`) is preserved when uploading the file to the registry.
+- `my-file.txt` is the file that is uploaded to the generic package. Only relative paths are supported, and the relative path (e.g. `folder/file.txt`) is preserved when uploading the file to the package.
 
 > A GitLab generic package may have multiple files with the same file name. However, it likely is not a great idea, as they cannot be downloaded separately from the GitLab API.
 
+To upload multiple files, or to upload a single file from a different directory, use `--source` argument. If no `--file` argument is set, all of the files in the source directory are uploaded, recursively. As an example, to upload all files from a `upload` folder to the package:
+
+```bash
+glpkg upload --project 12345 --name mypackagename --version 1.0 --source upload
+```
+
+Note: a file in `upload` folder will be uploaded to the root of the package. If you want to upload the file to a `dir` folder in the package, make a structure in the upload folder, like `upload/dir/`.
+
+### Delete a file from a generic package
+
+To delete a file from a specific generic package, run
+
+```bash
+glpkg delete --project 12345 --name mypackagename --version 1.0 --file my-file.txt
+```
+
+Where
+- `12345` is your projects ID ([Find the Project ID](https://docs.gitlab.com/user/project/working_with_projects/#find-the-project-id)) or the path of the project (like `namespace/project`)
+- `mypackagename` is the name of the generic package
+- `1.0` is the version of the generic package from the file is deleted
+- `my-file.txt` is the file that is deleted. Only relative paths are supported. Note that the package may contain multiple files with same name. In this case, one file of them is deleted.
+
+The token that is used to delete files must have at least Maintainer role in the project.
+
+### Delete a package version
+
+To delete a specific generic package version, run
+
+```bash
+glpkg delete --project 12345 --name mypackagename --version 1.0
+```
+
+Where
+- `12345` is your projects ID ([Find the Project ID](https://docs.gitlab.com/user/project/working_with_projects/#find-the-project-id)) or the path of the project (like `namespace/project`)
+- `mypackagename` is the name of the generic package
+- `1.0` is the version of the generic package that is deleted
+
+The token that is used to delete packages must have at least Maintainer role in the project.
+
 ### Use in GitLab pipelines
 
 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`.
@@ -120,11 +159,3 @@ glpkg upload --ci --name mypackagename --version 1.0 --file my-file.txt
 ```
 
 To use the `CI_JOB_TOKEN` with package registry of another projects, add `--project <otherproject ID>` argument. Remember that you may need to add [permissions for the CI_JOB_TOKEN](https://docs.gitlab.com/ci/jobs/ci_job_token/#control-job-token-access-to-your-project) in the other project.
-
-
-## Limitations
-
-The tool is not perfect (yet) and has limitations. The following limitations are known, but more can exist:
-
-- Uploading files must be done one-by-one.
-- Only project registries are supported for now.

glpkg-1.4.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+gitlab/__init__.py,sha256=TXqR34k7YgbFTeeKfSOdxBH0lFaC3-SiZU5mTBL9GI0,105
+gitlab/__main__.py,sha256=UPVixjP98KzJi9Ljth4yqqDTTaE3EfyAuj2xGCQAGys,586
+gitlab/cli_handler.py,sha256=02Yc3yE3jNMGTx_HvUu0rYH5NwxrnTRaaeAGMFh8Mq8,14273
+gitlab/packages.py,sha256=wP0hRLad09LoE9uinUljrvGoBt6KfP49QESqOpxLihQ,20255
+glpkg-1.4.0.dist-info/licenses/LICENSE.md,sha256=josGXvZq628dNS0Iru58-DPE7dRpDXzjJxKKT35103g,1065
+glpkg-1.4.0.dist-info/METADATA,sha256=PX4jWVi_HCznrjQ9OztSYqYurdqv1-qHXKbkRiIUVlU,7678
+glpkg-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+glpkg-1.4.0.dist-info/entry_points.txt,sha256=xHPZwx2oShYDZ3AyH7WSIvuhFMssy7QLlQk-JAbje_w,46
+glpkg-1.4.0.dist-info/top_level.txt,sha256=MvIaP8p_Oaf4gO_hXmHkX-5y2deHLp1pe6tJR3ukQ6o,7
+glpkg-1.4.0.dist-info/RECORD,,

glpkg-1.2.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-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,,