glpkg 1.4.2__tar.gz

glpkg-1.4.2/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2025 bugproduction
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

glpkg-1.4.2/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: glpkg
+Version: 1.4.2
+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
+Dynamic: license-file
+
+# glpkg - GitLab Generic Package tools 
+
+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
+
+Install the tool from with pip:
+
+```bash
+pip install glpkg
+```
+
+To check the installation and version, run:
+
+```bash
+glpkg --version
+```
+
+If you see a version in the terminal, you're good to go!
+
+## Usage
+
+When in doubt
+
+```bash
+glpkg --help
+```
+
+might help
+
+By default, the used GitLab host is gitlab.com. If you use a self-hosted GitLab, use argument `--host my-gitlab.net` with the commands.
+
+> Only https scheme is supported.
+
+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.
+
+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.
+
+### Listing package versions
+
+To list the versions of a generic package, run
+
+```bash
+glpkg list --project 12345 --name mypackagename
+```
+
+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
+
+The output will be, if package is found, something like:
+
+```bash
+Name            Version
+mypackagename   1.0
+mypackagename   1.5
+mypackagename   2.0
+```
+
+### Download generic package
+
+To download all files from a specific version of a generic package, run
+
+```bash
+glpkg download --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 from which the files are downloaded
+
+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.
+
+### Upload a file to a generic package
+
+To upload a file to a version of a generic package, run
+
+```bash
+glpkg upload --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 to which the file is uploaded
+- `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`.
+
+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:
+
+```bash
+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.

glpkg-1.4.2/README.md

@@ -0,0 +1,156 @@
+# glpkg - GitLab Generic Package tools 
+
+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
+
+Install the tool from with pip:
+
+```bash
+pip install glpkg
+```
+
+To check the installation and version, run:
+
+```bash
+glpkg --version
+```
+
+If you see a version in the terminal, you're good to go!
+
+## Usage
+
+When in doubt
+
+```bash
+glpkg --help
+```
+
+might help
+
+By default, the used GitLab host is gitlab.com. If you use a self-hosted GitLab, use argument `--host my-gitlab.net` with the commands.
+
+> Only https scheme is supported.
+
+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.
+
+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.
+
+### Listing package versions
+
+To list the versions of a generic package, run
+
+```bash
+glpkg list --project 12345 --name mypackagename
+```
+
+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
+
+The output will be, if package is found, something like:
+
+```bash
+Name            Version
+mypackagename   1.0
+mypackagename   1.5
+mypackagename   2.0
+```
+
+### Download generic package
+
+To download all files from a specific version of a generic package, run
+
+```bash
+glpkg download --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 from which the files are downloaded
+
+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.
+
+### Upload a file to a generic package
+
+To upload a file to a version of a generic package, run
+
+```bash
+glpkg upload --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 to which the file is uploaded
+- `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`.
+
+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:
+
+```bash
+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.

glpkg-1.4.2/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools"]
+
+[project]
+name = "glpkg"
+dynamic = ["version"]
+description = "Tool to make GitLab generic package registry operations easy."
+readme = "README.md"
+keywords = ["GitLab", "packages", "registry", "generic"]
+license = "MIT"
+license-files = ["LICENSE.md"]
+authors = [
+  { name="bugproduction", email="bugproduction@outlook.com" }
+]
+requires-python = ">= 3.9"
+dependencies = []
+
+[project.urls]
+Repository = "https://gitlab.com/bugproduction/glpkg.git"
+
+[project.scripts]
+glpkg = "gitlab.__main__:cli"
+
+
+[tool.setuptools.dynamic]
+version = {attr = "gitlab.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+addopts = "--cov=src --cov-report term"
+
+[tool.pylint.'MESSAGES CONTROL']
+min-public-methods = 1
+max-args = 6
+max-positional-arguments = 6
+ignore = ["build", "test"]

glpkg-1.4.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

glpkg-1.4.2/src/gitlab/__init__.py

@@ -0,0 +1,5 @@
+"""GitLab packages initialization module"""
+
+from gitlab.packages import Packages
+
+__version__ = "1.4.2"

glpkg-1.4.2/src/gitlab/__main__.py

@@ -0,0 +1,24 @@
+"""GitLab packages main module"""
+
+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.
+    """
+    handler = CLIHandler()
+    return handler.do_it()
+
+
+if __name__ == "__main__":
+    sys.exit(cli())