clear-skies-gitlab 2.0.1__tar.gz → 2.0.2__tar.gz

{clear_skies_gitlab-2.0.1 → clear_skies_gitlab-2.0.2}/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.2] - 2026-01-07
+
+### Changed
+- Rewrite modules
+- More models
+
 ## [2.0.1] - 2025-10-20
 
 ### Added
@@ -12,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add first models and backends
 
 ### Changed
+- Bump version to v2.0.1 by @github-actions[bot]
 - Initial project setup
 
 ### Fixed
@@ -19,6 +26,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Circular import
 
 ## New Contributors
+* @github-actions[bot] made their first contribution
 * @ made their first contribution
+[2.0.2]: https://github.com/clearskies-py/gitlab/compare/v2.0.1..v2.0.2
 
 <!-- generated by git-cliff -->

clear_skies_gitlab-2.0.2/LATEST_CHANGELOG.md

@@ -0,0 +1,6 @@
+## [2.0.2] - 2026-01-07
+
+### Changed
+- Rewrite modules
+- More models
+

{clear_skies_gitlab-2.0.1 → clear_skies_gitlab-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-gitlab
-Version: 2.0.1
+Version: 2.0.2
 Summary: Gitlab module for Clearskies
 Project-URL: Docs, https://https://clearskies.info/modules/clear-skies-gitlab
 Project-URL: Repository, https://github.com/clearskies-py/gitlab
@@ -15,7 +15,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Requires-Python: <4.0,>=3.11
 Requires-Dist: clear-skies>=2.0.0
-Requires-Dist: gql>=4.0.0
+Requires-Dist: gql[all]>=4.0.0
 Requires-Dist: requests>=2.32.5
 Provides-Extra: dev
 Requires-Dist: types-requests>=2.32.4; extra == 'dev'

clear_skies_gitlab-2.0.2/local.py

@@ -0,0 +1,70 @@
+#!/usr/bin/python3
+import logging
+from typing import Any
+
+import akeyless
+import clearskies
+
+import clearskies_gitlab
+from clearskies_gitlab.graphql import models as graphql
+from clearskies_gitlab.rest import models as rest
+
+logging.basicConfig(level=logging.WARN)
+
+
+def get_project(
+    gitlab_rest_projects: rest.GitlabRestProject, gitlab_gql_projects: graphql.GitlabProject
+) -> dict[str, Any]:
+    """Local test for projects."""
+    project = gitlab_rest_projects.find("id=Cimpress-Technology/cimsec/cimsec-pypi")
+    # print(f"Parent group: {project.group.name}")
+    # print(f"Count: {len(search_projects)}")
+    for variable in project.variables.paginate_all():
+        print(f"Variable: {variable.key} = {variable.value}")
+
+    gql_project = gitlab_gql_projects.find("id=278964")
+    print(f"GQL Parent group ID: {gql_project.id}")
+    print(f"GGL data: {gql_project.get_columns_data()}")
+    return project.group.id
+    # for project in search_projects.paginate_all():
+    #     print(project.name)
+
+
+def get_group(gitlab_rest_group: rest.GitlabRestGroup) -> dict[str, Any]:
+    """Local test for groups."""
+    group = gitlab_rest_group.find("id=Cimpress-Technology/cimsec")
+    # print(f"Group name: {group.name}")
+    # print(f"Count: {len(search_groups)}")
+    for variable in group.variables.paginate_all():
+        print(f"Variable: {variable.key} = {variable.value}")
+    for project in group.projects.limit(5):
+        print(f"Project: {project.name}")
+    for member in group.members.limit(5):
+        print(f"Member: {member.name}")
+    return group.id
+
+
+cli = clearskies.contexts.Cli(
+    clearskies.EndpointGroup(
+        [
+            clearskies.endpoints.Callable(
+                get_project,
+                url="/project",
+                return_standard_response=False,
+            ),
+            clearskies.endpoints.Callable(
+                get_group,
+                url="/group",
+                return_standard_response=False,
+            ),
+        ]
+    ),
+    modules=[clearskies_gitlab],
+    bindings={
+        "akeyless_sdk": akeyless,
+        "secrets": clearskies.secrets.Akeyless(access_id="p-je7a0rik2ptf", access_type="saml", profile="default"),
+    },
+)
+
+if __name__ == "__main__":
+    cli()

{clear_skies_gitlab-2.0.1 → clear_skies_gitlab-2.0.2}/pyproject.toml

@@ -1,14 +1,14 @@
 [project]
 name = "clear-skies-gitlab"
 description = "Gitlab module for Clearskies"
-version = "2.0.1"
+version = "2.0.2"
 license = "MIT"
 readme = "./README.md"
 authors = [{name = "Tom Nijboer", email = "tom.nijboer@cimpress.com"}]
 requires-python = ">=3.11,<4.0"
 dependencies = [
     "clear-skies>=2.0.0",
-    "gql>=4.0.0",
+    "gql[all]>=4.0.0",
     "requests>=2.32.5",
 ]
 classifiers = [
@@ -69,7 +69,6 @@ pythonpath = [
   "src"
 ]
 
-
 # This is the dedicated section for uv"s configuration
 [dependency-groups]
 dev = [

clear_skies_gitlab-2.0.2/ruff.toml

@@ -0,0 +1,117 @@
+#fixes
+fix = true
+show-fixes = true
+
+# Exclude a variety of commonly ignored directories.
+extend-exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+    "docs",
+]
+
+# Same as Black.
+line-length = 120
+indent-width = 4
+
+# Assume Python 3.13
+target-version = "py313"
+
+output-format = "gitlab"
+
+[lint]
+# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
+select = [
+    #"B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "D",  # pydocstyle
+    "E",  # Error
+    "F",  # pyflakes
+    "I",  # isort
+    "ISC", # flake8-implicit-str-concat
+    "N",  # pep8-naming
+    "PGH",  # pygrep-hooks
+    "PTH", # flake8-use-pathlib
+    "Q",  # flake8-quotes
+    "S",  # bandit
+    "SIM",  # flake8-simplify
+    "TRY",  # tryceratops
+    "UP",  # pyupgrade
+    "W",  # Warning
+    "YTT", # flake8-2020
+]
+ignore = [
+    "E501",
+    "D100",
+    "D104",
+    "D300", #triple double quotes
+    "D107",
+    "TRY003",
+]
+
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+# fixable = ["A", "B", "C", "D", "E", "F", "G", "I", "N", "Q", "S", "T", "W", "ANN", "ARG", "BLE", "COM", "DJ", "DTZ", "EM", "ERA", "EXE", "FBT", "ICN", "INP", "ISC", "NPY", "PD", "PGH", "PIE", "PL", "PT", "PTH", "PYI", "RET", "RSE", "RUF", "SIM", "SLF", "TCH", "TID", "TRY", "UP", "YTT"]
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[lint.mccabe]
+# Unlike Flake8, default to a complexity level of 10.
+max-complexity = 10
+
+[lint.pydocstyle]
+convention = "pep257"
+
+[lint.per-file-ignores]
+"tests/*.py" = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D105",
+    "D106",
+    "D107",
+    "S101",  # use of "assert"
+    "S102",  # use of "exec"
+    "S106",  # possible hardcoded password.
+    "PGH001",  # use of "eval"
+]
+
+[lint.pep8-naming]
+staticmethod-decorators = [
+    "pydantic.validator",
+    "pydantic.root_validator",
+]
+
+[format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/__init__.py

@@ -0,0 +1,3 @@
+from clearskies_gitlab import defaults, exceptions, graphql, rest
+
+__all__ = ["rest", "graphql", "defaults", "exceptions"]

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/defaults/__init__.py

@@ -0,0 +1,9 @@
+from clearskies_gitlab.defaults.gitlab_default_auth import GitlabDefaultAuth
+from clearskies_gitlab.defaults.gitlab_default_host import GitlabDefaultHost
+from clearskies_gitlab.defaults.gitlab_graphql_client import GitlabDefaultGraphqlClient
+
+__all__ = [
+    "GitlabDefaultAuth",
+    "GitlabDefaultHost",
+    "GitlabDefaultGraphqlClient",
+]

{clear_skies_gitlab-2.0.1 → clear_skies_gitlab-2.0.2}/src/clearskies_gitlab/defaults/gitlab_default_auth.py

@@ -2,6 +2,9 @@ import clearskies
 
 
 class GitlabDefaultAuth(clearskies.di.AdditionalConfigAutoImport):
+    """Provide default Gitlab authentication from environment."""
+
     def provide_gitlab_auth(self, environment: clearskies.Environment):
+        """Provide the Gitlab authentication from environment."""
         secret_key = environment.get("GITLAB_AUTH_KEY", True)
         return clearskies.authentication.SecretBearer(secret_key=secret_key, header_prefix="Bearer ")

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/defaults/gitlab_default_host.py

@@ -0,0 +1,10 @@
+import clearskies
+
+
+class GitlabDefaultHost(clearskies.di.AdditionalConfigAutoImport):
+    """Provide default GitLab Host from environment."""
+
+    def provide_gitlab_host(self, environment: clearskies.Environment):
+        """Provide the GitLab host from environment or default."""
+        gitlab_host = environment.get("GITLAB_HOST", True)
+        return gitlab_host if gitlab_host else "https://gitlab.com/"

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/defaults/gitlab_graphql_client.py

@@ -0,0 +1,18 @@
+import clearskies
+
+
+class GitlabDefaultGraphqlClient(clearskies.di.AdditionalConfigAutoImport):
+    """Provide default Gitlab authentication from environment."""
+
+    def provide_gitlab_graphql_client(
+        self,
+        gitlab_auth: clearskies.authentication.Authentication,
+        gitlab_host: str,
+        environment: clearskies.Environment,
+    ):
+        """Provide the Gitlab authentication from environment."""
+        return clearskies.clients.GraphqlClient(
+            endpoint=f"{gitlab_host.rstrip('/')}/api/graphql",
+            authentication=gitlab_auth,
+            timeout=30,
+        )

{clear_skies_gitlab-2.0.1 → clear_skies_gitlab-2.0.2}/src/clearskies_gitlab/exceptions/gitlab_error.py

@@ -47,4 +47,5 @@ class GitlabParamMissingError(ValueError):
     """Error if param is missing."""
 
     def __init__(self, param_name: str, table_name: str) -> None:
+        """Create error with param and table name."""
         super().__init__(f"Must provide the {param_name} to add the member to when updating a {table_name}")

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/__init__.py

@@ -0,0 +1,3 @@
+from clearskies_gitlab.graphql import backends, models
+
+__all__ = ["backends", "models"]

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/backends/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from clearskies_gitlab.graphql.backends.gitlab_graphql_backend import GitlabGraphqlBackend
+
+__all__ = [
+    "GitlabGraphqlBackend",
+]

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/backends/gitlab_graphql_backend.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from clearskies import configs, decorators
+from clearskies.backends import GraphqlBackend
+from clearskies.clients.graphql_client import GraphqlClient
+from clearskies.di import inject
+
+
+class GitlabGraphqlBackend(GraphqlBackend):
+    """Backend to gitlab using graphql."""
+
+    graphql_client_name = configs.String(default="gitlab_graphql_client")
+
+    api_to_model_map = configs.AnyDict(default={})
+    pagination_parameter_name = configs.String(default="page")
+    api_casing = configs.String(default="camelCase")
+    model_casing = configs.String(default="snake_case")
+
+    di = inject.Di()
+
+    @decorators.parameters_to_properties
+    def __init__(
+        self,
+        graphql_client: GraphqlClient | None = None,
+        graphql_client_name: str = "gitlab_graphql_client",
+        root_field: str = "",
+        pagination_style: str = "cursor",
+        api_case: str = "camelCase",
+        model_case: str = "snake_case",
+        is_collection: bool | None = None,
+        max_relationship_depth: int = 2,
+        relationship_limit: int = 10,
+        use_connection_for_relationships: bool = True,
+        id_argument_name: str | None = None,
+        id_argument_is_array: bool = False,
+        id_format_pattern: str = "",
+    ):
+        self.finalize_and_validate_configuration()

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/models/__init__.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from clearskies_gitlab.graphql.models.gitlab_container_repository import GitlabContainerRepository
+from clearskies_gitlab.graphql.models.gitlab_container_repository_tag import GitlabContainerRepositoryTag
+from clearskies_gitlab.graphql.models.gitlab_group import GitlabGroup
+from clearskies_gitlab.graphql.models.gitlab_project import GitlabProject
+
+__all__ = [
+    "GitlabContainerRepository",
+    "GitlabContainerRepositoryTag",
+    "GitlabProject",
+    "GitlabGroup",
+]

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/models/gitlab_container_repository.py

@@ -0,0 +1,34 @@
+from clearskies import Model
+from clearskies.columns import BelongsToId, BelongsToModel, Datetime, HasMany, String
+
+from clearskies_gitlab.graphql.backends import GitlabGraphqlBackend
+from clearskies_gitlab.graphql.models import gitlab_container_repository_tag_reference, gitlab_project_reference
+
+
+class GitlabContainerRepository(Model):
+    """Model for gitlab container repositories via GQL."""
+
+    id_column_name: str = "id"
+
+    backend = GitlabGraphqlBackend(
+        root_field="containerRepositories",
+        id_argument_is_array=True,
+        id_format_pattern="gid://gitlab/ContainerRepository/{id}",
+        id_argument_name="ids",
+    )
+
+    @classmethod
+    def destination_name(cls) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "containerRepository"
+
+    name = String()
+    location = String()
+    path = String()
+    created_at = Datetime()
+    project_id = BelongsToId(gitlab_project_reference.GitlabProjectReference)
+    project = BelongsToModel("project_id")
+    tags = HasMany(
+        gitlab_container_repository_tag_reference.GitlabContainerRepositoryTagReference,
+        foreign_column_name="containerRepositoryId",
+    )

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/models/gitlab_container_repository_reference.py

@@ -0,0 +1,8 @@
+class GitlabContainerRepositoryReference:
+    """Reference to GitlabContainerRepository model."""
+
+    def get_model_class(self) -> type:
+        """Return the model class this reference points to."""
+        from clearskies_gitlab.graphql.models import gitlab_container_repository
+
+        return gitlab_container_repository.GitlabContainerRepository

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/models/gitlab_container_repository_tag.py

@@ -0,0 +1,32 @@
+from clearskies import Model
+from clearskies.columns import BelongsToId, BelongsToModel, Datetime, String
+
+from clearskies_gitlab.graphql.backends import GitlabGraphqlBackend
+from clearskies_gitlab.graphql.models import gitlab_container_repository_reference
+
+
+class GitlabContainerRepositoryTag(Model):
+    """Model for gitlab container repositories via GQL."""
+
+    id_column_name: str = "name"
+
+    backend = GitlabGraphqlBackend(
+        root_field="containerRepositories",
+        id_argument_is_array=True,
+        id_format_pattern="gid://gitlab/ContainerRepository/{id}",
+        id_argument_name="ids",
+    )
+
+    @classmethod
+    def destination_name(cls) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "tag"
+
+    name = String()
+    digest = String()
+    location = String()
+    path = String()
+    created_at = Datetime()
+    published_at = Datetime()
+    container_repository_id = BelongsToId(gitlab_container_repository_reference.GitlabContainerRepositoryReference)
+    container_repository = BelongsToModel("container_repository_id")

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/models/gitlab_container_repository_tag_reference.py

@@ -0,0 +1,8 @@
+class GitlabContainerRepositoryTagReference:
+    """Reference to GitlabContainerRepositoryTag model."""
+
+    def get_model_class(self) -> type:
+        """Return the model class this reference points to."""
+        from clearskies_gitlab.graphql.models import gitlab_container_repository_tag
+
+        return gitlab_container_repository_tag.GitlabContainerRepositoryTag

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/models/gitlab_group.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from clearskies import Model
+
+from clearskies_gitlab.graphql.backends import GitlabGraphqlBackend
+
+
+class GitlabGroup(Model):
+    """Model for gitlab projects via GQL."""
+
+    gitlab_id_pattern: str = "gid://gitlab/Group/[ID]"
+
+    id_column_name: str = "id"
+    backend = GitlabGraphqlBackend(
+        root_field="groups",
+        id_argument_is_array=True,
+        id_format_pattern="gid://gitlab/Project/{id}",
+        id_argument_name="ids",
+    )
+
+    @classmethod
+    def destination_name(cls) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "group"

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/models/gitlab_group_reference.py

@@ -0,0 +1,8 @@
+class GitlabGroupReference:
+    """Reference to GitlabGroup model."""
+
+    def get_model_class(self) -> type:
+        """Return the model class this reference points to."""
+        from clearskies_gitlab.graphql.models import gitlab_group
+
+        return gitlab_group.GitlabGroup

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/models/gitlab_project.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from clearskies import Model
+from clearskies.columns import String
+
+from clearskies_gitlab.graphql.backends import GitlabGraphqlBackend
+
+
+class GitlabProject(Model):
+    """Model for gitlab projects via GQL."""
+
+    id_column_name: str = "id"
+    backend = GitlabGraphqlBackend(
+        root_field="projects",
+        id_argument_is_array=True,
+        id_format_pattern="gid://gitlab/Project/{id}",
+        id_argument_name="ids",
+    )
+
+    @classmethod
+    def destination_name(cls) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "projects"
+
+    id = String()

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/graphql/models/gitlab_project_reference.py

@@ -0,0 +1,8 @@
+class GitlabProjectReference:
+    """Reference to GitlabProject model."""
+
+    def get_model_class(self) -> type:
+        """Return the model class this reference points to."""
+        from clearskies_gitlab.graphql.models import gitlab_project
+
+        return gitlab_project.GitlabProject

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/rest/__init__.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from clearskies_gitlab.rest import backends, models
+from clearskies_gitlab.rest.gitlab_cicd_variable import GitlabCICDVariable
+from clearskies_gitlab.rest.gitlab_member import GitlabMember
+
+__all__ = [
+    "backends",
+    "models",
+    "GitlabMember",
+    "GitlabCICDVariable",
+]

clear_skies_gitlab-2.0.2/src/clearskies_gitlab/rest/backends/__init__.py

@@ -0,0 +1,3 @@
+from clearskies_gitlab.rest.backends.gitlab_rest_backend import GitlabRestBackend
+
+__all__ = ["GitlabRestBackend"]

{clear_skies_gitlab-2.0.1/src/clearskies_gitlab → clear_skies_gitlab-2.0.2/src/clearskies_gitlab/rest}/backends/gitlab_rest_backend.py

@@ -1,23 +1,16 @@
 from __future__ import annotations
 
-import logging
 import urllib
-from collections.abc import Callable
-from typing import TYPE_CHECKING, Any, cast
+from typing import TYPE_CHECKING, Any
 
-import requests
-from clearskies import Column, Model, configs
+from clearskies import configs
 from clearskies.backends import ApiBackend
 from clearskies.decorators import parameters_to_properties
 from clearskies.di import inject
-from clearskies.functional import string
 from clearskies.query import Query
 from requests.structures import CaseInsensitiveDict
 
-from clearskies_gitlab.exceptions import gitlab_error
-
 if TYPE_CHECKING:
-    from clearskies import model
     from clearskies.authentication import Authentication
     from clearskies.query import Query
 
@@ -25,8 +18,8 @@ if TYPE_CHECKING:
 class GitlabRestBackend(ApiBackend):
     """Backend for Gitlab.com."""
 
-    base_url = inject.ByName("gitlab_url", cache=True)
-    authentication = inject.ByName("gitlab_auth", cache=False)
+    gitlab_host = inject.ByName("gitlab_host", cache=True)  # type: ignore[assignment]
+    authentication = inject.ByName("gitlab_auth", cache=False)  # type: ignore[assignment]
     requests = inject.Requests()
     _auth_headers: dict[str, str] = {}
 
@@ -47,6 +40,17 @@ class GitlabRestBackend(ApiBackend):
     ):
         self.finalize_and_validate_configuration()
 
+    @property
+    def base_url(self) -> str:
+        """
+        Docstring for base_url.
+
+        :param self: Description
+        :return: Description
+        :rtype: str
+        """
+        return f"{self.gitlab_host.rstrip('/')}/api/v4"
+
     def count_method(self, query: Query) -> str:
         """Return the request method to use when making a request for a record count."""
         return "HEAD"
@@ -90,6 +94,7 @@ class GitlabRestBackend(ApiBackend):
     def conditions_to_request_parameters(
         self, query: Query, used_routing_parameters: list[str]
     ) -> tuple[str, dict[str, str], dict[str, Any]]:
+        """Convert query conditions to request parameters."""
         route_id = ""
 
         url_parameters = {}
@@ -111,7 +116,7 @@ class GitlabRestBackend(ApiBackend):
     #     self,
     #     next_page_data: dict[str, Any],
     #     query: Query,
-    #     response: requests.Response,  # type: ignore
+    #     response: requests.Response,
     # ) -> None:
     #     """
     #     Update the next_page_data dictionary with the appropriate data needed to fetch the next page of records.