docs(packages): add examples for Packages API and cli usagefeat/packages-api

3 files changed, 93 insertions, 0 deletions

diff --git a/docs/api-objects.rst b/docs/api-objects.rst
index 32852f8..5d59497 100644
--- a/docs/api-objects.rst
+++ b/docs/api-objects.rst
@@ -32,6 +32,7 @@ API examples
    gl_objects/milestones
    gl_objects/namespaces
    gl_objects/notes
+   gl_objects/packages
    gl_objects/pagesdomains
    gl_objects/pipelines_and_jobs
    gl_objects/projects
diff --git a/docs/cli.rst b/docs/cli.rst
index da5a89e..95f7062 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -235,6 +235,30 @@ List deploy tokens for a group:
 
    $ gitlab -v group-deploy-token list --group-id 3
 
+List packages for a project:
+
+.. code-block:: console
+
+   $ gitlab -v project-package list --project-id 3
+
+List packages for a group:
+
+.. code-block:: console
+
+   $ gitlab -v group-package list --group-id 3
+
+Get a specific project package by id:
+
+.. code-block:: console
+
+   $ gitlab -v project-package get --id 1 --project-id 3
+
+Delete a specific project package by id:
+
+.. code-block:: console
+
+   $ gitlab -v project-package delete --id 1 --project-id 3
+
 Get a list of snippets for this project:
 
 .. code-block:: console
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')
+