kerykeion 5.0.0a9__py3-none-any.whl → 5.0.0a11__py3-none-any.whl

kerykeion/kr_types/kr_models.py

@@ -34,19 +34,33 @@ class SubscriptableBaseModel(BaseModel):
     """
 
     def __getitem__(self, key):
+        """Get an attribute using dictionary-style access."""
         return getattr(self, key)
 
     def __setitem__(self, key, value):
+        """Set an attribute using dictionary-style access."""
         setattr(self, key, value)
 
     def __delitem__(self, key):
+        """Delete an attribute using dictionary-style access."""
         delattr(self, key)
 
     def get(self, key, default = None):
+        """Get an attribute with a default value if not found."""
         return getattr(self, key, default)
 
 
 class LunarPhaseModel(SubscriptableBaseModel):
+    """
+    Model representing lunar phase information.
+
+    Attributes:
+        degrees_between_s_m: Angular separation between Sun and Moon in degrees.
+        moon_phase: Numerical phase identifier for the Moon.
+        sun_phase: Numerical phase identifier for the Sun.
+        moon_emoji: Emoji representation of the lunar phase.
+        moon_phase_name: Text name of the lunar phase.
+    """
     degrees_between_s_m: Union[float, int]
     moon_phase: int
     sun_phase: int
@@ -56,7 +70,24 @@ class LunarPhaseModel(SubscriptableBaseModel):
 
 class KerykeionPointModel(SubscriptableBaseModel):
     """
-    Kerykeion Point Model
+    Model representing an astrological celestial point or house cusp.
+
+    This model contains comprehensive information about celestial objects
+    (planets, points) or house cusps including their zodiacal position,
+    sign placement, and metadata.
+
+    Attributes:
+        name: The name of the celestial point or house.
+        quality: Astrological quality (Cardinal, Fixed, Mutable).
+        element: Astrological element (Fire, Earth, Air, Water).
+        sign: The zodiac sign the point is located in.
+        sign_num: Numerical identifier for the zodiac sign (0-11).
+        position: Position within the sign (0-30 degrees).
+        abs_pos: Absolute position in the zodiac (0-360 degrees).
+        emoji: Unicode emoji representing the point or sign.
+        point_type: Type of the celestial point (Planet, House, etc.).
+        house: House placement of the point (optional).
+        retrograde: Whether the point is in retrograde motion (optional).
     """
 
     name: Union[AstrologicalPoint, Houses]
@@ -74,7 +105,29 @@ class KerykeionPointModel(SubscriptableBaseModel):
 
 class AstrologicalBaseModel(SubscriptableBaseModel):
     """
-    Base Model with common fields for all astrological subjects
+    Base model containing common fields for all astrological subjects.
+
+    This model serves as the foundation for all astrological chart types,
+    providing standard location, time, and configuration data. It supports
+    both complete charts (with full location/time data) and composite charts
+    (where some fields may be optional).
+
+    Attributes:
+        name: Subject identifier or name.
+        city: Location city (optional for composite charts).
+        nation: Country code (optional for composite charts).
+        lng: Longitude coordinate (optional for composite charts).
+        lat: Latitude coordinate (optional for composite charts).
+        tz_str: Timezone string (optional for composite charts).
+        iso_formatted_local_datetime: Local datetime in ISO format (optional).
+        iso_formatted_utc_datetime: UTC datetime in ISO format (optional).
+        julian_day: Julian day number for astronomical calculations (optional).
+        day_of_week: Day of the week (optional).
+        zodiac_type: Type of zodiac system used (Tropical or Sidereal).
+        sidereal_mode: Sidereal calculation mode (if applicable).
+        houses_system_identifier: House system used for calculations.
+        perspective_type: Astrological perspective (geocentric, heliocentric, etc.).
+        active_points: List of celestial points included in calculations.
     """
     # Common identification data
     name: str
@@ -285,6 +338,35 @@ class TransitMomentModel(SubscriptableBaseModel):
     aspects: List[AspectModel] = Field(description="List of aspects active at this specific moment.")
 
 
+class NatalAspectsModel(SubscriptableBaseModel):
+    """
+    Model representing all aspects in a natal chart.
+
+    Contains both all calculated aspects and the filtered relevant aspects
+    for an astrological subject.
+    """
+    subject: Union["AstrologicalSubjectModel", "CompositeSubjectModel", "PlanetReturnModel"] = Field(description="The astrological subject for which aspects were calculated.")
+    all_aspects: List[AspectModel] = Field(description="Complete list of all calculated aspects.")
+    relevant_aspects: List[AspectModel] = Field(description="Filtered list of relevant aspects based on orb settings.")
+    active_points: List[AstrologicalPoint] = Field(description="List of active points used in the calculation.")
+    active_aspects: List["ActiveAspect"] = Field(description="List of active aspects with their orb settings.")
+
+
+class SynastryAspectsModel(SubscriptableBaseModel):
+    """
+    Model representing all aspects between two astrological subjects.
+
+    Contains both all calculated synastry aspects and the filtered relevant aspects
+    between two charts.
+    """
+    first_subject: Union["AstrologicalSubjectModel", "CompositeSubjectModel", "PlanetReturnModel"] = Field(description="The first astrological subject.")
+    second_subject: Union["AstrologicalSubjectModel", "CompositeSubjectModel", "PlanetReturnModel"] = Field(description="The second astrological subject.")
+    all_aspects: List[AspectModel] = Field(description="Complete list of all calculated synastry aspects.")
+    relevant_aspects: List[AspectModel] = Field(description="Filtered list of relevant synastry aspects based on orb settings.")
+    active_points: List[AstrologicalPoint] = Field(description="List of active points used in the calculation.")
+    active_aspects: List["ActiveAspect"] = Field(description="List of active aspects with their orb settings.")
+
+
 class TransitsTimeRangeModel(SubscriptableBaseModel):
     """
     Model representing a collection of transit moments for an astrological subject.

kerykeion/kr_types/settings_models.py

@@ -5,7 +5,7 @@
 
 
 from pydantic import Field
-from typing import List, Optional, Union
+from typing import Optional
 from kerykeion.kr_types.kr_models import SubscriptableBaseModel
 
 
@@ -163,6 +163,14 @@ class KerykeionLanguageModel(SubscriptableBaseModel):
     return_point: str = Field(title="Return Point", description="The return point label in the chart, in the language")
     natal: str = Field(title="Natal", description="The natal label in the chart, in the language")
     perspective_type: str = Field(title="Perspective Type", description="The perspective type label in the chart, in the language")
+    location: str = Field(title="Location", description="The location label in the chart, in the language")
+    day_of_week: str = Field(title="Day of Week", description="The day of week label in the chart, in the language")
+    elements: str = Field(title="Elements", description="The elements label in the chart, in the language")
+    qualities: str = Field(title="Qualities", description="The qualities label in the chart, in the language")
+    cardinal: str = Field(title="Cardinal", description="The cardinal quality label in the chart, in the language")
+    fixed: str = Field(title="Fixed", description="The fixed quality label in the chart, in the language")
+    mutable: str = Field(title="Mutable", description="The mutable quality label in the chart, in the language")
+    birth_chart: str = Field(title="Birth Chart", description="The birth chart label in the chart, in the language")
 
 # Settings Model
 class KerykeionSettingsModel(SubscriptableBaseModel):