glpkg 1.3.0__tar.gz → 1.4.1__tar.gz

{glpkg-1.3.0/src/glpkg.egg-info → glpkg-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glpkg
-Version: 1.3.0
+Version: 1.4.1
 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
 ```
@@ -117,6 +117,37 @@ 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`.
@@ -128,10 +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:
-
-- Only project registries are supported for now.

{glpkg-1.3.0 → glpkg-1.4.1}/README.md

@@ -2,6 +2,7 @@
 
 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
 
@@ -13,7 +14,6 @@ pip install glpkg
 
 To check the installation and version,  run:
 
-
 ```bash
 glpkg --version
 ```
@@ -104,6 +104,37 @@ 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`.
@@ -115,10 +146,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:
-
-- Only project registries are supported for now.

{glpkg-1.3.0 → glpkg-1.4.1}/src/gitlab/__init__.py

@@ -2,4 +2,4 @@
 
 from gitlab.packages import Packages
 
-__version__ = "1.3.0"
+__version__ = "1.4.1"

{glpkg-1.3.0 → glpkg-1.4.1}/src/gitlab/__main__.py

@@ -1,6 +1,5 @@
 """GitLab packages main module"""
 
-import logging
 import sys
 
 from gitlab.cli_handler import CLIHandler
@@ -17,10 +16,6 @@ def cli() -> int:
     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()
 

{glpkg-1.3.0 → glpkg-1.4.1}/src/gitlab/cli_handler.py

@@ -40,6 +40,13 @@ class CLIHandler:
             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: argparse.Namespace) -> int:
@@ -240,16 +247,16 @@ class CLIHandler:
         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
@@ -287,10 +294,10 @@ class CLIHandler:
             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: argparse.ArgumentParser):
@@ -356,6 +363,57 @@ class CLIHandler:
                 print("File " + file + " does not exist!")
                 ret = 1
         if not ret:
-            gitlab = Packages(host, token_user, token)
-            ret = gitlab.upload_file(project, name, version, file, source)
+            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
+        packages = Packages(host, token_user, token)
+        if file:
+            ret = packages.delete_file(project, name, version, file)
+        else:
+            ret = packages.delete_package(project, name, version)
         return ret