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

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

@@ -5,12 +5,24 @@ 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-06
+
+### Added
+- Add teams
+
+### Changed
+- Make it all work with the api
+
+### Fixed
+- Use the built-in functions of clearskies now
+
 ## [2.0.1] - 2025-11-27
 
 ### Added
 - Add classes
 
 ### Changed
+- Bump version to v2.0.1 by @github-actions[bot]
 - Merge pull request #1 from clearskies-py/di-fix by @tnijboer in [#1](https://github.com/clearskies-py/cortex/pull/1)
 - Initial project setup
 
@@ -18,8 +30,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Pass dependencies and build the tree by @cmancone
 
 ## New Contributors
+* @github-actions[bot] made their first contribution
 * @tnijboer made their first contribution in [#1](https://github.com/clearskies-py/cortex/pull/1)
 * @cmancone made their first contribution
 * @ made their first contribution
+[2.0.2]: https://github.com/clearskies-py/cortex/compare/v2.0.1..v2.0.2
 
 <!-- generated by git-cliff -->

clear_skies_cortex-2.0.2/LATEST_CHANGELOG.md

@@ -0,0 +1,11 @@
+## [2.0.2] - 2026-01-06
+
+### Added
+- Add teams
+
+### Changed
+- Make it all work with the api
+
+### Fixed
+- Use the built-in functions of clearskies now
+

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-cortex
-Version: 2.0.1
+Version: 2.0.2
 Summary: Cortex module for Clearskies
 Project-URL: Docs, https://https://clearskies.info/modules/clear-skies-cortex
 Project-URL: Repository, https://github.com/clearskies-py/cortex

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

@@ -1,7 +1,7 @@
 [project]
 name = "clear-skies-cortex"
 description = "Cortex 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"}]
@@ -65,7 +65,7 @@ testpaths = [
     "integration",
 ]
 pythonpath = [
-  "app"
+  "src"
 ]
 
 # This is the dedicated section for uv"s configuration

clear_skies_cortex-2.0.2/src/clearskies_cortex/backends/cortex_backend.py

@@ -0,0 +1,100 @@
+from typing import Any
+
+import clearskies
+import requests
+from clearskies import Column, configs
+from clearskies.authentication import Authentication
+from clearskies.decorators import parameters_to_properties
+from clearskies.di import inject
+from clearskies.query import Query
+
+
+class CortexBackend(clearskies.backends.ApiBackend):
+    """Backend for Cortex.io."""
+
+    base_url = configs.String(default="https://api.getcortexapp.com/api/v1/")
+    authentication = inject.ByName("cortex_auth")  # type: ignore[assignment]
+    requests = inject.Requests()
+    api_casing = configs.Select(["snake_case", "camelCase", "TitleCase"], default="camelCase")
+
+    _auth_headers: dict[str, str] = {}
+
+    api_to_model_map = configs.AnyDict(default={})
+    pagination_parameter_name = configs.String(default="page")
+    limit_parameter_name = configs.String(default="pageSize")
+
+    can_count = True
+
+    @parameters_to_properties
+    def __init__(
+        self,
+        base_url: str | None = "https://api.getcortexapp.com/api/v1/",
+        authentication: Authentication | None = None,
+        model_casing: str = "snake_case",
+        api_casing: str = "camelCase",
+        api_to_model_map: dict[str, str | list[str]] = {},
+        pagination_parameter_name: str = "page",
+        pagination_parameter_type: str = "int",
+        limit_parameter_name: str = "pageSize",
+    ):
+        self.finalize_and_validate_configuration()
+
+    def count(self, query: Query) -> int:
+        """Return count of records matching query."""
+        self.check_query(query)
+        (url, method, body, headers) = self.build_records_request(query)
+        response = self.execute_request(url, method, json=body, headers=headers)
+        response.raise_for_status()
+        data = response.json()
+        if "total" in data:
+            return data["total"]
+        data = self.map_records_response(data, query)
+        return len(data)
+
+    def map_records_response(
+        self, response_data: Any, query: Query, query_data: dict[str, Any] | None = None
+    ) -> list[dict[str, Any]]:
+        """Map api response to model fields."""
+        if isinstance(response_data, dict):
+            if "page" in response_data:
+                del response_data["page"]
+                del response_data["totalPages"]
+                del response_data["total"]
+            first_item = next(iter(response_data))
+            if isinstance(response_data[first_item], list) and all(
+                isinstance(item, dict) for item in response_data[first_item]
+            ):
+                return super().map_records_response(response_data[first_item], query, query_data)
+        return super().map_records_response(response_data, query, query_data)
+
+    def set_next_page_data_from_response(
+        self,
+        next_page_data: dict[str, Any],
+        query: Query,
+        response: "requests.Response",  # type: ignore
+    ) -> None:
+        """
+        Update the next_page_data dictionary with the appropriate data needed to fetch the next page of records.
+
+        This method has a very important job, which is to inform clearskies about how to make another API call to fetch the next
+        page of records.  The way this happens is by updating the `next_page_data` dictionary in place with whatever pagination
+        information is necessary.  Note that this relies on next_page_data being passed by reference, hence the need to update
+        it in place.  That means that you can do this:
+
+        ```python
+        next_page_data["some_key"] = "some_value"
+        ```
+
+        but if you do this:
+
+        ```python
+        next_page_data = {"some_key": "some_value"}
+        ```
+
+        Then things simply won't work.
+        """
+        if isinstance(response.json(), dict):
+            page = response.json().get("page", None)
+            total_pages = response.json().get("totalPages", None)
+            if page is not None and total_pages is not None and page < total_pages:
+                next_page_data[self.pagination_parameter_name] = page + 1

{clear_skies_cortex-2.0.1 → clear_skies_cortex-2.0.2}/src/clearskies_cortex/backends/cortex_team_relationship_backend.py

@@ -8,7 +8,7 @@ from clearskies import Configurable, Model, configs
 from clearskies.backends.memory_backend import MemoryBackend, MemoryTable
 from clearskies.columns import String, Uuid
 from clearskies.di import inject
-from clearskies.query.query import Query
+from clearskies.query import Condition, Query
 
 from clearskies_cortex.backends import cortex_backend as rest_backend
 
@@ -61,20 +61,6 @@ class CortexTeamRelationshipBackend(MemoryBackend, Configurable):
             def destination_name(cls) -> str:
                 return "teams/relationships"
 
-        try:
-            relationship_data = self._get_cortex_backend().records(
-                Query(
-                    model_class=RelationshipModel,
-                ),
-                {},
-            )[0]
-
-        except IndexError:
-            relationship_data = {"edges": []}
-
-        # this should match up to exactly what backend.records() will return
-        # relationship_data = example_data["edges"]
-
         # we need to map this to the kind of row structure expected by the category_tree column
         # (see https://github.com/clearskies-py/clearskies/blob/main/src/clearskies/columns/category_tree.py)
         # This takes slightly more time up front but makes for quick lookups in both directions (and we'll
@@ -89,9 +75,14 @@ class CortexTeamRelationshipBackend(MemoryBackend, Configurable):
         root_categories: dict[str, str] = {}
         known_children: dict[str, str] = {}
         relationships: dict[str, set[str]] = {}
-        for relationship in relationship_data["edges"]:
-            child_category = relationship["childTeamTag"]
-            parent_category = relationship["parentTeamTag"]
+        for relationship in self._get_cortex_backend().records(
+            Query(
+                model_class=RelationshipModel,
+            ),
+            {},
+        ):
+            child_category = relationship["child_team_tag"]
+            parent_category = relationship["parent_team_tag"]
             # Skip if either parent or child is archived
             if parent_category not in relationships:
                 relationships[parent_category] = set()
@@ -115,8 +106,8 @@ class CortexTeamRelationshipBackend(MemoryBackend, Configurable):
             for idx, ancestor in enumerate(ancestors):
                 if (
                     not self.all_teams().get(node_name)
-                    or self.all_teams().get(node_name, {}).get("isArchived")
-                    or self.all_teams().get(ancestor, {}).get("isArchived")
+                    # or self.all_teams().get(node_name, {}).get("is_archived")
+                    # or self.all_teams().get(ancestor, {}).get("is_archived")
                 ):
                     continue
                 mapped.append(
@@ -162,13 +153,13 @@ class CortexTeamRelationshipBackend(MemoryBackend, Configurable):
         from clearskies_cortex.models.cortex_team import CortexTeam
 
         teams: dict[str, dict[str, Any]] = {}
-        team_result = self._get_cortex_backend().records(
+        for team in self._get_cortex_backend().records(
             Query(
                 model_class=CortexTeam,
+                conditions=[Condition("include_teams_without_members=true")],
             ),
             {},
-        )[0]
-        for team in team_result["teams"]:
-            teams[team["teamTag"]] = team
+        ):
+            teams[team["team_tag"]] = team
         self._cached_teams = teams
         return teams

{clear_skies_cortex-2.0.1 → clear_skies_cortex-2.0.2}/src/clearskies_cortex/dataclasses.py

@@ -20,7 +20,7 @@ class ServiceEntityHierarchyParent:
     description: str | None
     definition: None | dict[str, Any]
     parents: list["ServiceEntityHierarchyParent"]
-    groups: list[str]
+    groups: list[str] | None
 
 
 @dataclass
@@ -33,7 +33,7 @@ class ServiceEntityHierarchyChild:
     description: str | None
     definition: None | dict[str, Any]
     children: list["ServiceEntityHierarchyChild"]
-    groups: list[str]
+    groups: list[str] | None
 
 
 @dataclass

{clear_skies_cortex-2.0.1 → clear_skies_cortex-2.0.2}/src/clearskies_cortex/models/__init__.py

@@ -3,6 +3,7 @@ from clearskies_cortex.models.cortex_catalog_entity_domain import CortexCatalogE
 from clearskies_cortex.models.cortex_catalog_entity_group import CortexCatalogEntityGroup
 from clearskies_cortex.models.cortex_catalog_entity_scorecard import CortexCatalogEntityScorecard
 from clearskies_cortex.models.cortex_catalog_entity_service import CortexCatalogEntityService
+from clearskies_cortex.models.cortex_catalog_entity_team import CortexCatalogEntityTeam
 from clearskies_cortex.models.cortex_scorecard import CortexScorecard
 from clearskies_cortex.models.cortex_team import CortexTeam
 from clearskies_cortex.models.cortex_team_category_tree import CortexTeamCategoryTree
@@ -14,6 +15,7 @@ __all__ = [
     "CortexCatalogEntityGroup",
     "CortexCatalogEntityScorecard",
     "CortexCatalogEntityService",
+    "CortexCatalogEntityTeam",
     "CortexScorecard",
     "CortexTeam",
     "CortexTeamCategoryTree",

{clear_skies_cortex-2.0.1 → clear_skies_cortex-2.0.2}/src/clearskies_cortex/models/cortex_catalog_entity.py

@@ -1,11 +1,19 @@
-from typing import Self
+from collections.abc import Iterator
+from typing import Any, Self
 
 from clearskies import Model
 from clearskies.columns import Boolean, Datetime, HasMany, Json, String
+from clearskies.di import inject
+from clearskies.query import Query
+from dacite import from_dict
 
+from clearskies_cortex import dataclasses
 from clearskies_cortex.backends import CortexBackend
 from clearskies_cortex.columns import StringList
-from clearskies_cortex.models import cortex_catalog_entity_group, cortex_catalog_entity_scorecard
+from clearskies_cortex.models import (
+    cortex_catalog_entity_group,
+    cortex_catalog_entity_scorecard,
+)
 
 
 class CortexCatalogEntity(Model):
@@ -25,7 +33,7 @@ class CortexCatalogEntity(Model):
     groups = StringList("groups")
     owners = Json()
     ownership = Json()
-    ownersV2 = Json()
+    owners_v2 = Json()
     description = String()
     git = Json()
     hierarchy = Json()
@@ -46,6 +54,22 @@ class CortexCatalogEntity(Model):
         foreign_column_name="entity_tag",
     )
 
+    # search columns
+    hierarchy_depth = String(is_searchable=True, is_temporary=True)
+    git_repositories = StringList(is_searchable=True, is_temporary=True)
+    types = StringList(is_searchable=True, is_temporary=True)
+    query = String(is_searchable=True, is_temporary=True)
+    include_archived = Boolean(is_searchable=True, is_temporary=True)
+    include_metadata = Boolean(is_searchable=True, is_temporary=True)
+    include_links = Boolean(is_searchable=True, is_temporary=True)
+    include_owners = Boolean(is_searchable=True)
+    include_nested_fields = StringList(is_searchable=True, is_temporary=True)
+    include_hierarchy_fields = StringList(is_searchable=True, is_temporary=True)
+
+    def parse_hierarchy(self) -> dataclasses.ServiceEntityHierarchy:
+        """Parse the hierarchy column into a dictionary."""
+        return from_dict(dataclasses.ServiceEntityHierarchy, data=self.hierarchy)
+
     def parse_groups(self) -> dict[str, str]:
         """
         Parse the strings of groups.
@@ -60,3 +84,7 @@ class CortexCatalogEntity(Model):
                 if len(splitted) > 1:
                     parsed[splitted[0]] = splitted[1]
         return parsed
+
+    def parse_owners(self) -> dataclasses.EntityTeamOwner:
+        """Parse the owners column into a dictionary."""
+        return from_dict(dataclasses.EntityTeamOwner, data=self.owners)

clear_skies_cortex-2.0.2/src/clearskies_cortex/models/cortex_catalog_entity_domain.py

@@ -0,0 +1,38 @@
+from typing import Any, Self
+
+from clearskies import Column
+from clearskies.query import Condition, Query
+
+from clearskies_cortex.models import cortex_catalog_entity
+
+
+class CortexCatalogEntityDomain(cortex_catalog_entity.CortexCatalogEntity):
+    """Model for domain entities."""
+
+    def get_final_query(self) -> Query:
+        return (
+            self.get_query()
+            .add_where(Condition("types=domain"))
+            .add_where(Condition("include_nested_fields=team:members"))
+            .add_where(Condition("include_owners=true"))
+            .add_where(Condition("include_metadata=true"))
+            .add_where(Condition("include_hierarchy_fields=groups"))
+        )
+
+    def get_top_level_domain(self: Self) -> Self:
+        """Get the upper domain of this service if set."""
+        hierarchy = self.parse_hierarchy()
+        if hierarchy.parents:
+            parent = hierarchy.parents[0]
+            while parent.parents:
+                parent = parent.parents[0]
+            return self.as_query().find(f"tag={parent.tag}")
+        return self.empty()
+
+    def get_parent(self: Self) -> Self:
+        """Get the first domain of this service if set."""
+        hierarchy = self.parse_hierarchy()
+        if hierarchy.parents:
+            container = hierarchy.parents[0]
+            return self.as_query().find(f"tag={container.tag}")
+        return self.empty()

clear_skies_cortex-2.0.2/src/clearskies_cortex/models/cortex_catalog_entity_service.py

@@ -0,0 +1,76 @@
+import logging
+from typing import Any, Iterator, Self, cast
+
+from clearskies import Column
+from clearskies.di import inject
+from clearskies.query import Condition, Query
+from dacite import from_dict
+
+from clearskies_cortex import dataclasses
+from clearskies_cortex.backends import CortexBackend
+from clearskies_cortex.models import (
+    cortex_catalog_entity,
+    cortex_catalog_entity_domain,
+    cortex_team,
+)
+
+
+class CortexCatalogEntityService(cortex_catalog_entity.CortexCatalogEntity):
+    """Model for domain entities."""
+
+    backend = CortexBackend()
+
+    teams = inject.ByClass(cortex_team.CortexTeam)
+    entity_domains = inject.ByClass(cortex_catalog_entity_domain.CortexCatalogEntityDomain)
+
+    def get_final_query(self) -> Query:
+        return (
+            self.get_query()
+            .add_where(Condition("types=service"))
+            .add_where(Condition("include_nested_fields=team:members"))
+            .add_where(Condition("include_owners=true"))
+            .add_where(Condition("include_metadata=true"))
+            .add_where(Condition("include_hierarchy_fields=groups"))
+        )
+
+    def get_top_level_team(self: Self) -> cortex_team.CortexTeam:
+        """Find the top level team based on the team ownership."""
+        team = self.get_team()
+        if team:
+            return team.find_top_level_team()
+
+        return team
+
+    def get_team(self: Self) -> cortex_team.CortexTeam:
+        """Find the team based on the team ownership."""
+        team = self.teams.empty()
+        self.logger.debug(f"EntityService: owners {self.owners}")
+        if not self.owners:
+            return team
+        owners = self.parse_owners()
+        self.logger.debug(f"Parsed owners: {owners}")
+        if not owners.teams:
+            return team
+
+        entity_team = owners.teams[0]
+        self.logger.debug(f"Found entity team: {entity_team}")
+
+        return self.teams.find(f"team_tag={entity_team.tag}")
+
+    def get_top_level_domain(self: Self) -> cortex_catalog_entity_domain.CortexCatalogEntityDomain:
+        """Get the upper domain of this service if set."""
+        hierarchy = self.parse_hierarchy()
+        if hierarchy.parents:
+            parent = hierarchy.parents[0]
+            while parent.parents:
+                parent = parent.parents[0]
+            return self.entity_domains.find(f"tag={parent.tag}")
+        return self.entity_domains.empty()
+
+    def get_parent_domain(self: Self) -> cortex_catalog_entity_domain.CortexCatalogEntityDomain:
+        """Get the first domain of this service if set."""
+        hierarchy = self.parse_hierarchy()
+        if hierarchy.parents:
+            container = hierarchy.parents[0]
+            return self.entity_domains.find(f"tag={container.tag}")
+        return self.entity_domains.empty()

clear_skies_cortex-2.0.2/src/clearskies_cortex/models/cortex_catalog_entity_team.py

@@ -0,0 +1,38 @@
+from typing import Any, Self
+
+from clearskies import Column
+from clearskies.query import Condition, Query
+
+from clearskies_cortex.models import cortex_catalog_entity
+
+
+class CortexCatalogEntityTeam(cortex_catalog_entity.CortexCatalogEntity):
+    """Model for team entities."""
+
+    def get_final_query(self) -> Query:
+        return (
+            self.get_query()
+            .add_where(Condition("types=team"))
+            .add_where(Condition("include_nested_fields=team:members"))
+            .add_where(Condition("include_owners=true"))
+            .add_where(Condition("include_metadata=true"))
+            .add_where(Condition("include_hierarchy_fields=groups"))
+        )
+
+    def get_top_level_team(self: Self) -> Self:
+        """Get the upper team of this service if set."""
+        hierarchy = self.parse_hierarchy()
+        if hierarchy.parents:
+            parent = hierarchy.parents[0]
+            while parent.parents:
+                parent = parent.parents[0]
+            return self.as_query().find(f"tag={parent.tag}")
+        return self.empty()
+
+    def get_parent(self: Self) -> Self:
+        """Get the first team of this service if set."""
+        hierarchy = self.parse_hierarchy()
+        if hierarchy.parents:
+            team = hierarchy.parents[0]
+            return self.as_query().find(f"tag={team.tag}")
+        return self.empty()

{clear_skies_cortex-2.0.1 → clear_skies_cortex-2.0.2}/src/clearskies_cortex/models/cortex_team.py

@@ -1,4 +1,4 @@
-from typing import Self, cast
+from typing import Self
 
 from clearskies import Model
 from clearskies.columns import (
@@ -8,6 +8,7 @@ from clearskies.columns import (
     CategoryTreeAncestors,
     CategoryTreeChildren,
     CategoryTreeDescendants,
+    Datetime,
     Json,
     String,
 )
@@ -21,7 +22,11 @@ class CortexTeam(Model):
 
     id_column_name: str = "team_tag"
 
-    backend = CortexBackend()
+    backend = CortexBackend(
+        api_to_model_map={
+            "cortexTeam.members": "members",
+        }
+    )
 
     @classmethod
     def destination_name(cls: type[Self]) -> str:
@@ -45,8 +50,10 @@ class CortexTeam(Model):
     metadata = Json()
     slack_channels = Json()
     type = String()
-    cortex_team = Json()
+    members = Json()
     id = String()
+    last_updated = Datetime()
+    include_teams_without_members = Boolean(is_searchable=True, is_temporary=True)
 
     def get_name(self) -> str:
         """Retrieve name from metadata."""