kerykeion 5.0.0a12__py3-none-any.whl → 5.0.0b1__py3-none-any.whl

kerykeion/{kr_types → schemas}/kr_models.py

@@ -3,12 +3,12 @@
     This is part of Kerykeion (C) 2025 Giacomo Battaglia
 """
 
-from typing import Union, Optional, List
+from typing import Union, Optional, List, Literal
 from typing_extensions import TypedDict
 from pydantic import BaseModel, Field
-from kerykeion.kr_types.kr_literals import AspectName
+from kerykeion.schemas.kr_literals import AspectName
 
-from kerykeion.kr_types import (
+from kerykeion.schemas import (
     LunarPhaseEmoji,
     LunarPhaseName,
     AstrologicalPoint,
@@ -24,8 +24,9 @@ from kerykeion.kr_types import (
     SignsEmoji,
     RelationshipScoreDescription,
     PerspectiveType,
-    ReturnType
+    AspectMovementType
 )
+from kerykeion.schemas.kr_literals import ReturnType
 
 
 class SubscriptableBaseModel(BaseModel):
@@ -57,13 +58,11 @@ class LunarPhaseModel(SubscriptableBaseModel):
     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
     moon_emoji: LunarPhaseEmoji
     moon_phase_name: LunarPhaseName
 
@@ -101,6 +100,8 @@ class KerykeionPointModel(SubscriptableBaseModel):
     point_type: PointType
     house: Optional[Houses] = None
     retrograde: Optional[bool] = None
+    speed: Optional[float] = None
+    declination: Optional[float] = None
 
 
 class AstrologicalBaseModel(SubscriptableBaseModel):
@@ -223,11 +224,11 @@ class AstrologicalBaseModel(SubscriptableBaseModel):
     eleventh_house: KerykeionPointModel
     twelfth_house: KerykeionPointModel
 
-    # Common nodes
-    mean_node: Optional[KerykeionPointModel] = None
-    true_node: Optional[KerykeionPointModel] = None
-    mean_south_node: Optional[KerykeionPointModel] = None
-    true_south_node: Optional[KerykeionPointModel] = None
+    # Lunar Nodes
+    mean_north_lunar_node: Optional[KerykeionPointModel] = None
+    true_north_lunar_node: Optional[KerykeionPointModel] = None
+    mean_south_lunar_node: Optional[KerykeionPointModel] = None
+    true_south_lunar_node: Optional[KerykeionPointModel] = None
 
     # Common lists and settings
     houses_names_list: List[Houses] = Field(description="Ordered list of houses names")
@@ -297,6 +298,10 @@ class AspectModel(SubscriptableBaseModel):
     diff: float
     p1: int
     p2: int
+    aspect_movement: AspectMovementType = Field(
+        description="Indicates whether the aspect is applying (planets moving toward exact aspect), "
+                    "separating (planets moving away from exact aspect), or exact (within tight orb)."
+    )
 
 
 class ZodiacSignModel(SubscriptableBaseModel):
@@ -394,3 +399,207 @@ class TransitsTimeRangeModel(SubscriptableBaseModel):
     transits: List[TransitMomentModel] = Field(description="List of transit moments.")
     subject: Optional[AstrologicalSubjectModel] = Field(description="Astrological subject data.")
     dates: Optional[List[str]] = Field(description="ISO 8601 formatted dates of all transit moments.")
+
+
+class PointInHouseModel(SubscriptableBaseModel):
+    """
+    Represents an astrological point from one subject positioned within another subject's house.
+
+    Captures point characteristics and its placement within the target subject's house system
+    for house comparison analysis.
+
+    Attributes:
+        point_name: Name of the astrological point
+        point_degree: Degree position within its sign
+        point_sign: Zodiacal sign containing the point
+        point_owner_name: Name of the subject who owns this point
+        point_owner_house_number: House number in owner's chart
+        point_owner_house_name: House name in owner's chart
+        projected_house_number: House number in target subject's chart
+        projected_house_name: House name in target subject's chart
+        projected_house_owner_name: Name of the target subject
+    """
+
+    point_name: str
+    """Name of the astrological point"""
+    point_degree: float
+    """Degree position of the point within its zodiacal sign"""
+    point_sign: str
+    """Zodiacal sign containing the point"""
+    point_owner_name: str
+    """Name of the subject who owns this point"""
+    point_owner_house_number: Optional[int]
+    """House number in owner's chart"""
+    point_owner_house_name: Optional[str]
+    """House name in owner's chart"""
+    projected_house_number: int
+    """House number in target subject's chart"""
+    projected_house_name: str
+    """House name in target subject's chart"""
+    projected_house_owner_name: str
+    """Name of the target subject"""
+
+
+class HouseComparisonModel(SubscriptableBaseModel):
+    """
+    Bidirectional house comparison analysis between two astrological subjects.
+
+    Contains results of how astrological points from each subject interact with
+    the house system of the other subject.
+
+    Attributes:
+        first_subject_name: Name of the first subject
+        second_subject_name: Name of the second subject
+        first_points_in_second_houses: First subject's points in second subject's houses
+        second_points_in_first_houses: Second subject's points in first subject's houses
+    """
+
+    first_subject_name: str
+    """Name of the first subject"""
+    second_subject_name: str
+    """Name of the second subject"""
+    first_points_in_second_houses: List[PointInHouseModel]
+    """First subject's points positioned in second subject's houses"""
+    second_points_in_first_houses: List[PointInHouseModel]
+    """Second subject's points positioned in first subject's houses"""
+
+
+class ElementDistributionModel(SubscriptableBaseModel):
+    """
+    Model representing element distribution in a chart.
+
+    Attributes:
+        fire: Fire element points total
+        earth: Earth element points total
+        air: Air element points total
+        water: Water element points total
+        fire_percentage: Fire element percentage
+        earth_percentage: Earth element percentage
+        air_percentage: Air element percentage
+        water_percentage: Water element percentage
+    """
+    fire: float
+    earth: float
+    air: float
+    water: float
+    fire_percentage: int
+    earth_percentage: int
+    air_percentage: int
+    water_percentage: int
+
+
+class QualityDistributionModel(SubscriptableBaseModel):
+    """
+    Model representing quality distribution in a chart.
+
+    Attributes:
+        cardinal: Cardinal quality points total
+        fixed: Fixed quality points total
+        mutable: Mutable quality points total
+        cardinal_percentage: Cardinal quality percentage
+        fixed_percentage: Fixed quality percentage
+        mutable_percentage: Mutable quality percentage
+    """
+    cardinal: float
+    fixed: float
+    mutable: float
+    cardinal_percentage: int
+    fixed_percentage: int
+    mutable_percentage: int
+
+
+class SingleChartDataModel(SubscriptableBaseModel):
+    """
+    Chart data model for single-subject astrological charts.
+
+    This model contains all pure data from single-subject charts including planetary
+    positions, internal aspects, element/quality distributions, and location data.
+    Used for chart types that analyze a single astrological subject.
+
+    Supported chart types:
+    - Natal: Birth chart with internal planetary aspects
+    - Composite: Midpoint relationship chart with internal aspects
+    - SingleReturnChart: Single planetary return with internal aspects
+
+    Attributes:
+        chart_type: Type of single chart (Natal, Composite, SingleReturnChart)
+        subject: The astrological subject being analyzed
+        aspects: Internal aspects within the chart
+        element_distribution: Distribution of elemental energies
+        quality_distribution: Distribution of modal qualities
+        active_points: Celestial points included in calculations
+        active_aspects: Aspect types and orb settings used
+    """
+
+    # Chart identification
+    chart_type: Literal["Natal", "Composite", "SingleReturnChart"]
+
+    # Single chart subject
+    subject: Union["AstrologicalSubjectModel", "CompositeSubjectModel", "PlanetReturnModel"]
+
+    # Internal aspects analysis
+    aspects: "SingleChartAspectsModel"
+
+    # Element and quality distributions
+    element_distribution: "ElementDistributionModel"
+    quality_distribution: "QualityDistributionModel"
+
+    # Configuration and metadata
+    active_points: List[AstrologicalPoint]
+    active_aspects: List["ActiveAspect"]
+
+
+class DualChartDataModel(SubscriptableBaseModel):
+    """
+    Chart data model for dual-subject astrological charts.
+
+    This model contains all pure data from dual-subject charts including both subjects,
+    inter-chart aspects, house comparisons, relationship analysis, and combined
+    element/quality distributions. Used for chart types that compare or overlay
+    two astrological subjects.
+
+    Supported chart types:
+    - Transit: Natal chart with current planetary transits
+    - Synastry: Relationship compatibility between two people
+    - Return: Natal chart with planetary return comparison
+
+    Attributes:
+        chart_type: Type of dual chart (Transit, Synastry, Return)
+        first_subject: Primary astrological subject (natal, base chart)
+        second_subject: Secondary astrological subject (transit, partner, return)
+        aspects: Inter-chart aspects between the two subjects
+        house_comparison: House overlay analysis between subjects
+        relationship_score: Compatibility scoring (synastry only)
+        element_distribution: Combined elemental distribution
+        quality_distribution: Combined modal distribution
+        active_points: Celestial points included in calculations
+        active_aspects: Aspect types and orb settings used
+    """
+
+    # Chart identification
+    chart_type: Literal["Transit", "Synastry", "DualReturnChart"]
+
+    # Dual chart subjects
+    first_subject: Union["AstrologicalSubjectModel", "CompositeSubjectModel", "PlanetReturnModel"]
+    second_subject: Union["AstrologicalSubjectModel", "PlanetReturnModel"]
+
+    # Inter-chart aspects analysis
+    aspects: "DualChartAspectsModel"
+
+    # House comparison analysis
+    house_comparison: Optional["HouseComparisonModel"] = None
+
+    # Relationship analysis (synastry only)
+    relationship_score: Optional["RelationshipScoreModel"] = None
+
+    # Combined element and quality distributions
+    element_distribution: "ElementDistributionModel"
+    quality_distribution: "QualityDistributionModel"
+
+    # Configuration and metadata
+    active_points: List[AstrologicalPoint]
+    active_aspects: List["ActiveAspect"]
+
+
+# Union type for all chart data models
+ChartDataModel = Union[SingleChartDataModel, DualChartDataModel]

kerykeion/{kr_types → schemas}/settings_models.py

@@ -6,7 +6,7 @@
 
 from pydantic import Field
 from typing import Optional
-from kerykeion.kr_types.kr_models import SubscriptableBaseModel
+from kerykeion.schemas.kr_models import SubscriptableBaseModel
 
 
 class KerykeionSettingsCelestialPointModel(SubscriptableBaseModel):
@@ -39,16 +39,16 @@ class KerykeionLanguageCelestialPointModel(SubscriptableBaseModel):
     Uranus: str = Field(title="Uranus", description="The name of Uranus in the chart, in the language")
     Neptune: str = Field(title="Neptune", description="The name of Neptune in the chart, in the language")
     Pluto: str = Field(title="Pluto", description="The name of Pluto in the chart, in the language")
-    True_Node: str = Field(title="True Node", description="The name of True Node in the chart, in the language")
-    Mean_Node: str = Field(title="Mean Node", description="The name of Mean Node in the chart, in the language")
+    True_North_Lunar_Node: str = Field(title="True North Lunar Node", description="The name of True North Lunar Node in the chart, in the language")
+    Mean_North_Lunar_Node: str = Field(title="Mean North Lunar Node", description="The name of Mean North Lunar Node in the chart, in the language")
     Chiron: str = Field(title="Chiron", description="The name of Chiron in the chart, in the language")
     Ascendant: str = Field(title="Ascendant", description="The name of Ascendant in the chart, in the language")
     Descendant: str = Field(title="Descendant", description="The name of Descendant in the chart, in the language")
     Medium_Coeli: str = Field(title="Medium Coeli", description="The name of Medium Coeli in the chart, in the language")
     Imum_Coeli: str = Field(title="Imum Coeli", description="The name of Imum Coeli in the chart, in the language")
     Mean_Lilith: str = Field(title="Mean Lilith", description="The name of Mean Lilith in the chart, in the language")
-    True_South_Node: str = Field(title="True South Node", description="The name of True South Node in the chart, in the language")
-    Mean_South_Node: str = Field(title="Mean South Node", description="The name of Mean South Node in the chart, in the language")
+    True_South_Lunar_Node: str = Field(title="True South Lunar Node", description="The name of True South Lunar Node in the chart, in the language")
+    Mean_South_Lunar_Node: str = Field(title="Mean South Lunar Node", description="The name of Mean South Lunar Node in the chart, in the language")
     True_Lilith: str = Field(title="True Lilith", description="The name of True Lilith in the chart, in the language")
     Earth: str = Field(title="Earth", description="The name of Earth in the chart, in the language")
     Pholus: str = Field(title="Pholus", description="The name of Pholus in the chart, in the language")
@@ -149,11 +149,10 @@ class KerykeionLanguageModel(SubscriptableBaseModel):
     houses_system_X: str = Field(title="Houses System X", description="The houses system X label in the chart, in the language")
     houses_system_Y: str = Field(title="Houses System Y", description="The houses system Y label in the chart, in the language")
     Natal: str = Field(title="Natal", description="The natal chart label in the chart, in the language")
-    ExternalNatal: str = Field(title="External Natal", description="The external natal chart label in the chart, in the language")
     Synastry: str = Field(title="Synastry", description="The synastry chart label in the chart, in the language")
     Transit: str = Field(title="Transit", description="The transit chart label in the chart, in the language")
     Composite: str = Field(title="Composite", description="The composite chart label in the chart, in the language")
-    Return: str = Field(title="Return", description="The return chart label in the chart, in the language")
+    Return: str = Field(title="DualReturnChart", description="The return chart label in the chart, in the language")
     return_aspects: str = Field(title="Return Aspects", description="The return aspects label in the chart, in the language")
     solar_return: str = Field(title="Solar Return", description="The solar return label in the chart, in the language")
     lunar_return: str = Field(title="Lunar Return", description="The lunar return label in the chart, in the language")
@@ -171,6 +170,7 @@ class KerykeionLanguageModel(SubscriptableBaseModel):
     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")
+    weekdays: Optional[dict[str, str]] = Field(default=None, title="Weekdays", description="Mapping of English weekday names to localized names")
 
 # Settings Model
 class KerykeionSettingsModel(SubscriptableBaseModel):

kerykeion/settings/config_constants.py

@@ -1,5 +1,5 @@
-from kerykeion.kr_types.kr_literals import AstrologicalPoint
-from kerykeion.kr_types.kr_models import ActiveAspect
+from kerykeion.schemas.kr_literals import AstrologicalPoint
+from kerykeion.schemas.kr_models import ActiveAspect
 from typing import List
 
 
@@ -14,10 +14,10 @@ DEFAULT_ACTIVE_POINTS: List[AstrologicalPoint] = [
     "Uranus",
     "Neptune",
     "Pluto",
-    # "Mean_Node",
-    "True_Node",
-    # "Mean_South_Node",
-    "True_South_Node",
+    # "Mean_North_Lunar_Node",
+    "True_North_Lunar_Node",
+    # "Mean_South_Lunar_Node",
+    "True_South_Lunar_Node",
     "Chiron",
     "Mean_Lilith",
     # "True_Lilith",
@@ -49,7 +49,56 @@ DEFAULT_ACTIVE_POINTS: List[AstrologicalPoint] = [
 ]
 """
 Default list of active points in the charts or aspects calculations.
-The full list of points is available in the `kr_types.kr_literals.AstrologicalPoint` literal.
+The full list of points is available in the `schemas.kr_literals.AstrologicalPoint` literal.
+"""
+
+ALL_ACTIVE_POINTS: List[AstrologicalPoint] = [
+    "Sun",
+    "Moon",
+    "Mercury",
+    "Venus",
+    "Mars",
+    "Jupiter",
+    "Saturn",
+    "Uranus",
+    "Neptune",
+    "Pluto",
+    "Mean_North_Lunar_Node",
+    "True_North_Lunar_Node",
+    "Mean_South_Lunar_Node",
+    "True_South_Lunar_Node",
+    "Chiron",
+    "Mean_Lilith",
+    "True_Lilith",
+    "Earth",
+    "Pholus",
+    "Ceres",
+    "Pallas",
+    "Juno",
+    "Vesta",
+    "Eris",
+    "Sedna",
+    "Haumea",
+    "Makemake",
+    "Ixion",
+    "Orcus",
+    "Quaoar",
+    "Regulus",
+    "Spica",
+    "Ascendant",
+    "Medium_Coeli",
+    "Descendant",
+    "Imum_Coeli",
+    "Vertex",
+    "Anti_Vertex",
+    "Pars_Fortunae",
+    "Pars_Spiritus",
+    "Pars_Amoris",
+    "Pars_Fidei"
+]
+"""
+Full list of active points in the charts or aspects calculations.
+The full list of points is available in the `schemas.kr_literals.AstrologicalPoint` literal.
 """
 
 DEFAULT_ACTIVE_ASPECTS: List[ActiveAspect] = [
@@ -67,7 +116,25 @@ DEFAULT_ACTIVE_ASPECTS: List[ActiveAspect] = [
 ]
 """
 Default list of active aspects in the aspects calculations.
-The full list of aspects is available in the `kr_types.kr_literals.AspectName` literal.
+The full list of aspects is available in the `schemas.kr_literals.AspectName` literal.
+"""
+
+ALL_ACTIVE_ASPECTS: List[ActiveAspect] = [
+    {"name": "conjunction", "orb": 10},
+    {"name": "opposition", "orb": 10},
+    {"name": "trine", "orb": 8},
+    {"name": "sextile", "orb": 6},
+    {"name": "square", "orb": 5},
+    {"name": "quintile", "orb": 1},
+    {"name": "semi-sextile", "orb": 1},
+    {"name": "semi-square", "orb": 1},
+    {"name": "sesquiquadrate", "orb": 1},
+    {"name": "biquintile", "orb": 1},
+    {"name": "quincunx", "orb": 1},
+]
+"""
+Full list of active aspects in the charts or aspects calculations.
+The full list of aspects is available in the `schemas.kr_literals.AspectName` literal.
 """
 
 DISCEPOLO_SCORE_ACTIVE_ASPECTS: List[ActiveAspect] = [

kerykeion/settings/kerykeion_settings.py

@@ -8,7 +8,7 @@ from json import load
 import logging
 from pathlib import Path
 from typing import Dict, Union
-from kerykeion.kr_types import KerykeionSettingsModel
+from kerykeion.schemas import KerykeionSettingsModel
 import functools