python-gitlab 4.12.2__tar.gz → 4.13.0__tar.gz

{python_gitlab-4.12.2 → python_gitlab-4.13.0}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## v4.13.0 (2024-10-08)
+
+### Chore
+
+* chore(deps): update dependency pre-commit to v4 (#3008)
+
+Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> ([`5c27546`](https://github.com/python-gitlab/python-gitlab/commit/5c27546d35ced76763ea8b0071b4ec4c896893a1))
+
+* chore(deps): update all non-major dependencies ([`c3efb37`](https://github.com/python-gitlab/python-gitlab/commit/c3efb37c050268de3f1ef5e24748ccd9487e346d))
+
+### Feature
+
+* feat(api): add support for project Pages API ([`0ee0e02`](https://github.com/python-gitlab/python-gitlab/commit/0ee0e02f1d1415895f6ab0f6d23b39b50a36446a))
+
 ## v4.12.2 (2024-10-01)
 
 ### Fix

{python_gitlab-4.12.2 → python_gitlab-4.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.12.2
+Version: 4.13.0
 Summary: A python wrapper for the GitLab API
 Author-email: Gauvain Pocentek <gauvain@pocentek.net>
 Maintainer-email: John Villalovos <john@sodarock.com>, Max Wittig <max.wittig@siemens.com>, Nejc Habjan <nejc.habjan@siemens.com>, Roger Meier <r.meier@siemens.com>

{python_gitlab-4.12.2 → python_gitlab-4.13.0}/docs/gl_objects/pagesdomains.rst

@@ -1,9 +1,38 @@
-#############
-Pages domains
-#############
+#######################
+Pages and Pages domains
+#######################
 
-Admin
-=====
+Project pages
+=============
+
+References
+----------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectPages`
+  + :class:`gitlab.v4.objects.ProjectPagesManager`
+  + :attr:`gitlab.v4.objects.Project.pages`
+
+* GitLab API: https://docs.gitlab.com/ee/api/pages.html
+
+Examples
+--------
+
+Get Pages settings for a project::
+
+    pages = project.pages.get()
+
+Update Pages settings for a project::
+
+    project.pages.update(new_data={'pages_https_only': True})
+
+Delete (unpublish) Pages for a project (admin only)::
+
+    project.pages.delete()
+
+Pages domains (admin only)
+==========================
 
 References
 ----------
@@ -23,8 +52,8 @@ List all the existing domains (admin only)::
 
     domains = gl.pagesdomains.list()
 
-Project pages domain
-====================
+Project Pages domains
+=====================
 
 References
 ----------

{python_gitlab-4.12.2 → python_gitlab-4.13.0}/gitlab/_version.py

@@ -3,4 +3,4 @@ __copyright__ = "Copyright 2013-2019 Gauvain Pocentek, 2019-2023 python-gitlab t
 __email__ = "gauvainpocentek@gmail.com"
 __license__ = "LGPL3"
 __title__ = "python-gitlab"
-__version__ = "4.12.2"
+__version__ = "4.13.0"

{python_gitlab-4.12.2 → python_gitlab-4.13.0}/gitlab/v4/objects/pages.py

@@ -1,7 +1,17 @@
 from typing import Any, cast, Union
 
 from gitlab.base import RESTManager, RESTObject
-from gitlab.mixins import CRUDMixin, ListMixin, ObjectDeleteMixin, SaveMixin
+from gitlab.mixins import (
+    CRUDMixin,
+    DeleteMixin,
+    GetWithoutIdMixin,
+    ListMixin,
+    ObjectDeleteMixin,
+    RefreshMixin,
+    SaveMixin,
+    UpdateMethod,
+    UpdateMixin,
+)
 from gitlab.types import RequiredOptional
 
 __all__ = [
@@ -9,6 +19,8 @@ __all__ = [
     "PagesDomainManager",
     "ProjectPagesDomain",
     "ProjectPagesDomainManager",
+    "ProjectPages",
+    "ProjectPagesManager",
 ]
 
 
@@ -38,3 +50,20 @@ class ProjectPagesDomainManager(CRUDMixin, RESTManager):
         self, id: Union[str, int], lazy: bool = False, **kwargs: Any
     ) -> ProjectPagesDomain:
         return cast(ProjectPagesDomain, super().get(id=id, lazy=lazy, **kwargs))
+
+
+class ProjectPages(ObjectDeleteMixin, RefreshMixin, RESTObject):
+    _id_attr = None
+
+
+class ProjectPagesManager(DeleteMixin, UpdateMixin, GetWithoutIdMixin, RESTManager):
+    _path = "/projects/{project_id}/pages"
+    _obj_cls = ProjectPages
+    _from_parent_attrs = {"project_id": "id"}
+    _update_attrs = RequiredOptional(
+        optional=("pages_unique_domain_enabled", "pages_https_only")
+    )
+    _update_method: UpdateMethod = UpdateMethod.PATCH
+
+    def get(self, **kwargs: Any) -> ProjectPages:
+        return cast(ProjectPages, super().get(**kwargs))

{python_gitlab-4.12.2 → python_gitlab-4.13.0}/gitlab/v4/objects/projects.py

@@ -78,7 +78,7 @@ from .notes import ProjectNoteManager  # noqa: F401
 from .notification_settings import ProjectNotificationSettingsManager  # noqa: F401
 from .package_protection_rules import ProjectPackageProtectionRuleManager
 from .packages import GenericPackageManager, ProjectPackageManager  # noqa: F401
-from .pages import ProjectPagesDomainManager  # noqa: F401
+from .pages import ProjectPagesDomainManager, ProjectPagesManager  # noqa: F401
 from .pipelines import (  # noqa: F401
     ProjectPipeline,
     ProjectPipelineManager,
@@ -216,6 +216,7 @@ class Project(
     notificationsettings: ProjectNotificationSettingsManager
     packages: ProjectPackageManager
     package_protection_rules: ProjectPackageProtectionRuleManager
+    pages: ProjectPagesManager
     pagesdomains: ProjectPagesDomainManager
     pipelines: ProjectPipelineManager
     pipelineschedules: ProjectPipelineScheduleManager

{python_gitlab-4.12.2 → python_gitlab-4.13.0}/python_gitlab.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.12.2
+Version: 4.13.0
 Summary: A python wrapper for the GitLab API
 Author-email: Gauvain Pocentek <gauvain@pocentek.net>
 Maintainer-email: John Villalovos <john@sodarock.com>, Max Wittig <max.wittig@siemens.com>, Nejc Habjan <nejc.habjan@siemens.com>, Roger Meier <r.meier@siemens.com>

python_gitlab-4.13.0/requirements-precommit.txt

@@ -0,0 +1 @@
+pre-commit==4.0.0

{python_gitlab-4.12.2 → python_gitlab-4.13.0}/requirements-test.txt

@@ -1,5 +1,5 @@
 -r requirements.txt
-build==1.2.2
+build==1.2.2.post1
 coverage==7.6.1
 pytest-console-scripts==1.4.1
 pytest-cov==5.0.0

{python_gitlab-4.12.2 → python_gitlab-4.13.0}/tests/functional/api/test_projects.py

@@ -240,6 +240,18 @@ def test_project_milestone_promotion(gl, group):
     )
 
 
+def test_project_pages(project):
+    pages = project.pages.get()
+    assert pages.is_unique_domain_enabled is True
+
+    project.pages.update(new_data={"pages_unique_domain_enabled": False})
+
+    pages.refresh()
+    assert pages.is_unique_domain_enabled is False
+
+    project.pages.delete()
+
+
 def test_project_pages_domains(gl, project):
     domain = project.pagesdomains.create({"domain": "foo.domain.com"})
     assert domain in project.pagesdomains.list()

python_gitlab-4.12.2/requirements-precommit.txt

@@ -1 +0,0 @@
-pre-commit==3.8.0