diff options
Diffstat (limited to 'docs/gl_objects/packages.rst')
-rw-r--r-- | docs/gl_objects/packages.rst | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/gl_objects/packages.rst b/docs/gl_objects/packages.rst new file mode 100644 index 0000000..3c1782b --- /dev/null +++ b/docs/gl_objects/packages.rst @@ -0,0 +1,68 @@ +####### +Packages +####### + +Packages allow you to utilize GitLab as a private repository for a variety +of common package managers. + +Project Packages +===================== + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectPackage` + + :class:`gitlab.v4.objects.ProjectPackageManager` + + :attr:`gitlab.v4.objects.Project.packages` + +* GitLab API: https://docs.gitlab.com/ee/api/packages.html#within-a-project + +Examples +-------- + +List the packages in a project:: + + packages = project.packages.list() + +Filter the results by ``package_type`` or ``package_name`` :: + + packages = project.packages.list(package_type='pypi') + +Get a specific package of a project by id:: + + package = project.packages.get(1) + +Delete a package from a project:: + + package.delete() + # or + project.packages.delete(package.id) + + +Group Packages +=================== + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.GroupPackage` + + :class:`gitlab.v4.objects.GroupPackageManager` + + :attr:`gitlab.v4.objects.Group.packages` + +* GitLab API: https://docs.gitlab.com/ee/api/packages.html#within-a-group + +Examples +-------- + +List the packages in a group:: + + packages = group.packages.list() + +Filter the results by ``package_type`` or ``package_name`` :: + + packages = group.packages.list(package_type='pypi') + |