clear-skies-cortex 2.0.3__py3-none-any.whl → 2.0.5__py3-none-any.whl

clearskies_cortex/models/cortex_entity_relationships.py

@@ -7,7 +7,27 @@ from clearskies_cortex.backends import CortexBackend
 
 
 class CortexCatalogEntityRelationship(Model):
-    """Model for entities."""
+    """
+    Model for Cortex entity relationships.
+
+    This model represents relationships between entities in the Cortex catalog.
+    Relationships define connections between entities such as dependencies,
+    ownership, or custom relationship types.
+
+    The model connects to the Cortex API endpoint
+    `catalog/:tag/relationships/:relationship_type_tag/destinations` to fetch
+    relationship destination entities.
+
+    ```python
+    from clearskies_cortex.models import CortexCatalogEntityRelationship
+
+    # Fetch relationship destinations for an entity
+    relationships = CortexCatalogEntityRelationship()
+    destinations = relationships.where("tag=my-service").where("relationship_type_tag=depends-on")
+    for dest in destinations:
+        print(f"Depends on: {dest.name} ({dest.type})")
+    ```
+    """
 
     id_column_name: str = "tag"
 
@@ -18,8 +38,27 @@ class CortexCatalogEntityRelationship(Model):
         """Return the slug of the api endpoint for this model."""
         return "catalog/:tag/relationships/:relationship_type_tag/destinations"
 
+    """
+    The unique identifier for the relationship destination entity.
+    """
     id = String()
+
+    """
+    The tag identifier of the relationship destination entity.
+    """
     tag = String()
+
+    """
+    A description of the relationship destination entity.
+    """
     description = String()
+
+    """
+    The human-readable name of the relationship destination entity.
+    """
     name = String()
+
+    """
+    The type of the relationship destination entity (e.g., "service", "domain").
+    """
     type = String()

clearskies_cortex/models/cortex_model.py

@@ -4,6 +4,29 @@ from clearskies_cortex.backends import CortexBackend
 
 
 class CortexModel(Model):
-    """Base model for cortex."""
+    """
+    Base model for Cortex API integration.
+
+    This is the foundational model class for all Cortex-related models. It pre-configures
+    the CortexBackend for API communication with the Cortex platform.
+
+    Extend this class to create models that interact with the Cortex API:
+
+    ```python
+    from clearskies_cortex.models import CortexModel
+    from clearskies.columns import String, Json
+
+
+    class MyCustomCortexModel(CortexModel):
+        id_column_name = "my_id"
+
+        my_id = String()
+        data = Json()
+
+        @classmethod
+        def destination_name(cls):
+            return "my-endpoint"
+    ```
+    """
 
     backend = CortexBackend()

clearskies_cortex/models/cortex_scorecard.py

@@ -8,7 +8,25 @@ from clearskies_cortex.backends import CortexBackend
 
 
 class CortexScorecard(Model):
-    """Model for scorecards."""
+    """
+    Model for Cortex scorecards.
+
+    This model represents scorecard definitions in Cortex. Scorecards define rules and
+    criteria for measuring entity compliance, quality, and maturity levels.
+
+    The model connects to the Cortex API endpoint `scorecards` to fetch scorecard definitions.
+
+    ```python
+    from clearskies_cortex.models import CortexScorecard
+
+    # Fetch all scorecards
+    scorecards = CortexScorecard()
+    for scorecard in scorecards:
+        print(f"Scorecard: {scorecard.scorecard_tag}")
+        if not scorecard.is_archived:
+            print("  Status: Active")
+    ```
+    """
 
     id_column_name: str = "scorecard_tag"
 
@@ -19,9 +37,32 @@ class CortexScorecard(Model):
         """Return the slug of the api endpoint for this model."""
         return "scorecards"
 
+    """
+    The unique tag identifier for the scorecard.
+    """
     scorecard_tag = String()
+
+    """
+    The tag of the catalog entity associated with this scorecard.
+    """
     catalog_entity_tag = String()
+
+    """
+    Whether the scorecard is archived.
+    """
     is_archived = Boolean()
+
+    """
+    JSON object containing external links associated with the scorecard.
+    """
     links = Json()
+
+    """
+    JSON object containing custom metadata for the scorecard.
+    """
     metadata = Json()
+
+    """
+    JSON object containing Slack channel configurations for notifications.
+    """
     slack_channels = Json()

clearskies_cortex/models/cortex_team.py

@@ -18,7 +18,37 @@ from clearskies_cortex.models import cortex_team_category_tree
 
 
 class CortexTeam(Model):
-    """Model for teams."""
+    """
+    Model for Cortex teams.
+
+    This model represents teams in Cortex. Teams are organizational units that own and manage
+    services and other entities. Teams support hierarchical relationships through parent-child
+    connections.
+
+    The model connects to the Cortex API endpoint `teams` and provides navigation through
+    team hierarchies using CategoryTree relationships.
+
+    ```python
+    from clearskies_cortex.models import CortexTeam
+
+    # Fetch all teams
+    teams = CortexTeam()
+    for team in teams:
+        print(f"Team: {team.get_name()}")
+
+    # Find a specific team
+    team = teams.find("team_tag=my-team")
+
+    # Navigate team hierarchy
+    if team.has_parents():
+        top_team = team.find_top_level_team()
+        print(f"Top-level team: {top_team.get_name()}")
+
+    if team.has_childeren():
+        for child in team.children:
+            print(f"Child team: {child.get_name()}")
+    ```
+    """
 
     id_column_name: str = "team_tag"
 
@@ -33,26 +63,93 @@ class CortexTeam(Model):
         """Return the slug of the api endpoint for this model."""
         return "teams"
 
+    """
+    The unique tag identifier for the team.
+    """
     team_tag = String()
+
+    """
+    The tag of the catalog entity associated with this team.
+    """
     catalog_entity_tag = String()
+
+    """
+    Whether the team is archived.
+    """
     is_archived = Boolean()
+
+    """
+    CategoryTree relationship for parent team navigation.
+
+    Uses CortexTeamCategoryTree to manage hierarchical team relationships.
+    """
     parent_team_tag = CategoryTree(
         cortex_team_category_tree.CortexTeamCategoryTree,
         load_relatives_strategy="individual",
         tree_child_id_column_name="child_team_tag",
         tree_parent_id_column_name="parent_team_tag",
     )
+
+    """
+    The parent team model instance.
+    """
     parent = BelongsToModel("parent_team_tag")
+
+    """
+    List of direct child teams.
+    """
     children = CategoryTreeChildren("parent_team_tag")
+
+    """
+    List of all ancestor teams (from immediate parent to root).
+    """
     ancestors = CategoryTreeAncestors("parent_team_tag")
+
+    """
+    List of all descendant teams (all children recursively).
+    """
     descendants = CategoryTreeDescendants("parent_team_tag")
+
+    """
+    JSON object containing external links associated with the team.
+    """
     links = Json()
+
+    """
+    JSON object containing custom metadata for the team.
+
+    Includes the team name accessible via `get_name()`.
+    """
     metadata = Json()
+
+    """
+    JSON object containing Slack channel configurations.
+    """
     slack_channels = Json()
+
+    """
+    The type of team.
+    """
     type = String()
+
+    """
+    JSON object containing team member information.
+    """
     members = Json()
+
+    """
+    The unique identifier for the team.
+    """
     id = String()
+
+    """
+    Timestamp of when the team was last updated.
+    """
     last_updated = Datetime()
+
+    """
+    Search parameter: Include teams without members in results.
+    """
     include_teams_without_members = Boolean(is_searchable=True, is_temporary=True)
 
     def get_name(self) -> str:

clearskies_cortex/models/cortex_team_category_tree.py

@@ -9,7 +9,28 @@ from clearskies_cortex.backends import CortexBackend, CortexTeamRelationshipBack
 
 
 class CortexTeamCategoryTree(Model):
-    """Model for teams."""
+    """
+    Model for Cortex team hierarchy relationships.
+
+    This model represents the hierarchical relationships between teams in Cortex.
+    It is used internally by the CategoryTree column type to manage parent-child
+    team relationships.
+
+    The model connects to the Cortex API endpoint `teams/relationships` using the
+    CortexTeamRelationshipBackend to transform the API response into a format
+    suitable for clearskies CategoryTree operations.
+
+    ```python
+    from clearskies_cortex.models import CortexTeamCategoryTree
+
+    # This model is typically used internally by CortexTeam
+    # Direct usage example:
+    tree = CortexTeamCategoryTree()
+    relationships = tree.where("parent_team_tag=my-parent-team")
+    for rel in relationships:
+        print(f"Child: {rel.child_team_tag}, Level: {rel.level}")
+    ```
+    """
 
     id_column_name: str = "id"
 
@@ -20,8 +41,27 @@ class CortexTeamCategoryTree(Model):
         """Return the slug of the api endpoint for this model."""
         return "teams/relationships"
 
+    """
+    Unique identifier for the relationship record.
+    """
     id = Uuid()
+
+    """
+    The tag of the parent team in the relationship.
+    """
     parent_team_tag = String()
+
+    """
+    The tag of the child team in the relationship.
+    """
     child_team_tag = String()
+
+    """
+    Whether this record represents a parent relationship.
+    """
     is_parent = Boolean()
+
+    """
+    The depth level in the hierarchy (0 for direct parent/child).
+    """
     level = Integer()

clearskies_cortex/models/cortex_team_department.py

@@ -8,7 +8,24 @@ from clearskies_cortex.backends import CortexBackend
 
 
 class CortexTeamDepartment(Model):
-    """Model for departments."""
+    """
+    Model for Cortex team departments.
+
+    This model represents departments within teams in Cortex. Departments are organizational
+    subdivisions within teams that can have their own members and descriptions.
+
+    The model connects to the Cortex API endpoint `teams/departments` to fetch department data.
+
+    ```python
+    from clearskies_cortex.models import CortexTeamDepartment
+
+    # Fetch all departments
+    departments = CortexTeamDepartment()
+    for dept in departments:
+        print(f"Department: {dept.name}")
+        print(f"Description: {dept.description}")
+    ```
+    """
 
     backend = CortexBackend()
     id_column_name: str = "department_tag"
@@ -18,8 +35,27 @@ class CortexTeamDepartment(Model):
         """Return the slug of the api endpoint for this model."""
         return "teams/departments"
 
+    """
+    The unique tag identifier for the department.
+    """
     department_tag = String()
+
+    """
+    The tag of the catalog entity associated with this department.
+    """
     catalog_entity_tag = String()
+
+    """
+    A description of the department's purpose and responsibilities.
+    """
     description = String()
+
+    """
+    The human-readable name of the department.
+    """
     name = String()
+
+    """
+    JSON object containing department member information.
+    """
     members = Json()

clear_skies_cortex-2.0.3.dist-info/RECORD

@@ -1,28 +0,0 @@
-clearskies_cortex/__init__.py,sha256=SwFkNfKLJgcq2qE6YJ_78_JfeoRGojlKuR_3DymZZSQ,142
-clearskies_cortex/dataclasses.py,sha256=rmSwJkMPwyfQltHuGzRRn9OrwMXKHajkG1jA39ix9lU,1446
-clearskies_cortex/backends/__init__.py,sha256=Ek74kpJLE7ERY-6yhH2KwFO25gm3Yjz51laUApnhgnU,179
-clearskies_cortex/backends/cortex_backend.py,sha256=kmF54P0W3eK2BpCAh4dpIBPmo6iWKU7oUYSPB-IG7IE,4149
-clearskies_cortex/backends/cortex_team_relationship_backend.py,sha256=UiMZp0jcKvpx3tLbR8aMBS8-KIfECxJGiwM3fz8DmuM,7648
-clearskies_cortex/columns/__init__.py,sha256=BpoVCEVXRtKcsyRFnAYLtlwYtHBjciUbzuzaBxmfH00,87
-clearskies_cortex/columns/string_list.py,sha256=khsJS_0T4XZvTeXFpRvZsFX8iNTWbx_urCEa9Tv0Bmo,754
-clearskies_cortex/defaults/__init__.py,sha256=tulZSvFgp4YUKj_bnArIevmlpC8z_AQKO0okYs4hCDo,216
-clearskies_cortex/defaults/default_cortex_auth.py,sha256=yA5kCwGxPEdV2t-28UArkKXgI3qbxt-7P6az4cLI1Rg,508
-clearskies_cortex/defaults/default_cortex_url.py,sha256=SaR6dQW3ELtuy4Woap8ufYL_zGQ0K0XwHUv0CYi_p78,305
-clearskies_cortex/models/__init__.py,sha256=zckJ4-KOjIcmtN7h7lXOESUu3d6JBsZZJq-s2MJ0NLQ,1145
-clearskies_cortex/models/cortex_catalog_entity.py,sha256=ASwCKiZ682YvsFUrkPo8J_MQYCT_39aElJGWDTDH7GQ,3060
-clearskies_cortex/models/cortex_catalog_entity_domain.py,sha256=gApQwSIGO0UGxhkJo-aaDK7clCxmTQTzHcgCjdPAZEE,1386
-clearskies_cortex/models/cortex_catalog_entity_group.py,sha256=dvuwwuj8Mwm0HgqVjkz1MpUycBAl9WUrDNC0XNGeWGk,514
-clearskies_cortex/models/cortex_catalog_entity_scorecard.py,sha256=sWp_v7O9uY3VbJjdb_VWUPHgBIn-rRj6kZDHqZq4lXI,908
-clearskies_cortex/models/cortex_catalog_entity_service.py,sha256=GeJmR9qfRjNFwxbJriJeTWMm4L4yH-z6wCXQWXAolg4,2780
-clearskies_cortex/models/cortex_catalog_entity_team.py,sha256=mKVKjOMf0xOk53XJI8juPQzNSdHvmxI1bJWfQVCKEQQ,1364
-clearskies_cortex/models/cortex_catalog_entity_types.py,sha256=EJBRv0ZMHwZ6HpaXxy0A_EBGqmu9EeVAZiX4xPIljz4,568
-clearskies_cortex/models/cortex_entity_relationships.py,sha256=bB46YFK8Vc2SZsvobvFeyTfEj8YfcaXFaPnkW0o_nG4,607
-clearskies_cortex/models/cortex_model.py,sha256=QmwQ45vuK4iUKCJsOk1pwu1at8IYKg39pYO9TtlYrEA,175
-clearskies_cortex/models/cortex_scorecard.py,sha256=YlINfUGudmqQHe-0ZpD2qOzAUKWshUycwgXYEcxqsUk,663
-clearskies_cortex/models/cortex_team.py,sha256=LXqHx_lwBvuVMyUlj1l2Sfpngj0zTZGpVi0WrJP-o3E,2246
-clearskies_cortex/models/cortex_team_category_tree.py,sha256=PLC-9E5kuMeItow7RKFX7jKUiAfJ-7ehXIy3eeaFzr8,721
-clearskies_cortex/models/cortex_team_department.py,sha256=DL3k91462-R0VVqbUQgBfYM_TndE5MKmDPBSF448XYw,639
-clear_skies_cortex-2.0.3.dist-info/METADATA,sha256=aDSWFEtcMWOw5fGdQGg1B--y7ECfX89nyI1WRa-36jg,2117
-clear_skies_cortex-2.0.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-clear_skies_cortex-2.0.3.dist-info/licenses/LICENSE,sha256=MkEX8JF8kZxdyBpTTcB0YTd-xZpWnHvbRlw-pQh8u58,1069
-clear_skies_cortex-2.0.3.dist-info/RECORD,,