kerykeion 4.26.3__py3-none-any.whl → 5.0.0__py3-none-any.whl

kerykeion/kr_types/kr_models.py

@@ -1,324 +1,20 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2025 Giacomo Battaglia
-"""
-
+Backward compatibility module for kr_models.
 
-from typing import Union, Optional
-from typing_extensions import TypedDict
-from pydantic import BaseModel
-from kerykeion.kr_types.kr_literals import AspectName
+DEPRECATED: This module will be removed in Kerykeion v6.0.
+Please update your imports:
+    OLD: from kerykeion.kr_types.kr_models import ...
+    NEW: from kerykeion.schemas.kr_models import ...
+"""
+import warnings
 
-from kerykeion.kr_types import (
-    AxialCusps,
-    LunarPhaseEmoji,
-    LunarPhaseName,
-    Planet,
-    Houses,
-    Quality,
-    Element,
-    Sign,
-    ZodiacType,
-    SignNumbers,
-    PointType,
-    SiderealMode,
-    HousesSystemIdentifier,
-    Houses,
-    SignsEmoji,
-    RelationshipScoreDescription,
-    PerspectiveType
+warnings.warn(
+    "The 'kerykeion.kr_types.kr_models' module is deprecated and will be removed in v6.0. "
+    "Please update your imports to use 'kerykeion.schemas.kr_models' instead.",
+    DeprecationWarning,
+    stacklevel=2,
 )
 
-
-class SubscriptableBaseModel(BaseModel):
-    """
-    Pydantic BaseModel with subscriptable support, so you can access the fields as if they were a dictionary.
-    """
-
-    def __getitem__(self, key):
-        return getattr(self, key)
-
-    def __setitem__(self, key, value):
-        setattr(self, key, value)
-
-    def __delitem__(self, key):
-        delattr(self, key)
-
-    def get(self, key, default = None):
-        return getattr(self, key, default)
-
-
-class LunarPhaseModel(SubscriptableBaseModel):
-    degrees_between_s_m: Union[float, int]
-    moon_phase: int
-    sun_phase: int
-    moon_emoji: LunarPhaseEmoji
-    moon_phase_name: LunarPhaseName
-
-
-class KerykeionPointModel(SubscriptableBaseModel):
-    """
-    Kerykeion Point Model
-    """
-
-    name: Union[Planet, Houses, AxialCusps]
-    quality: Quality
-    element: Element
-    sign: Sign
-    sign_num: SignNumbers
-    position: float
-    abs_pos: float
-    emoji: str
-    point_type: PointType
-    house: Optional[Houses] = None
-    retrograde: Optional[bool] = None
-
-
-class AstrologicalSubjectModel(SubscriptableBaseModel):
-    """
-    Pydantic Model for Astrological Subject
-    """
-
-    # Data
-    name: str
-    year: int
-    month: int
-    day: int
-    hour: int
-    minute: int
-    city: str
-    nation: str
-    lng: float
-    lat: float
-    tz_str: str
-    zodiac_type: ZodiacType
-    sidereal_mode: Union[SiderealMode, None]
-    houses_system_identifier: HousesSystemIdentifier
-    houses_system_name: str
-    perspective_type: PerspectiveType
-    iso_formatted_local_datetime: str
-    iso_formatted_utc_datetime: str
-    julian_day: float
-
-    # Deprecated properties -->
-    utc_time: float
-    local_time: float
-    # <-- Deprecated properties
-
-
-    # Planets
-    sun: KerykeionPointModel
-    moon: KerykeionPointModel
-    mercury: KerykeionPointModel
-    venus: KerykeionPointModel
-    mars: KerykeionPointModel
-    jupiter: KerykeionPointModel
-    saturn: KerykeionPointModel
-    uranus: KerykeionPointModel
-    neptune: KerykeionPointModel
-    pluto: KerykeionPointModel
-
-    # Axes
-    ascendant: KerykeionPointModel
-    descendant: KerykeionPointModel
-    medium_coeli: KerykeionPointModel
-    imum_coeli: KerykeionPointModel
-
-    # Optional Planets:
-    chiron: Union[KerykeionPointModel, None]
-    mean_lilith: Union[KerykeionPointModel, None]
-
-    # Houses
-    first_house: KerykeionPointModel
-    second_house: KerykeionPointModel
-    third_house: KerykeionPointModel
-    fourth_house: KerykeionPointModel
-    fifth_house: KerykeionPointModel
-    sixth_house: KerykeionPointModel
-    seventh_house: KerykeionPointModel
-    eighth_house: KerykeionPointModel
-    ninth_house: KerykeionPointModel
-    tenth_house: KerykeionPointModel
-    eleventh_house: KerykeionPointModel
-    twelfth_house: KerykeionPointModel
-
-    # Nodes
-    mean_node: KerykeionPointModel
-    true_node: KerykeionPointModel
-    mean_south_node: KerykeionPointModel
-    true_south_node: KerykeionPointModel
-
-    planets_names_list: list[Planet]
-    """Ordered list of available planets names"""
-
-    axial_cusps_names_list: list[AxialCusps]
-    """Ordered list of available axes names"""
-
-    houses_names_list: list[Houses]
-    """Ordered list of houses names"""
-
-    lunar_phase: LunarPhaseModel
-    """Lunar phase model"""
-
-
-class EphemerisDictModel(SubscriptableBaseModel):
-    date: str
-    planets: list[KerykeionPointModel]
-    houses: list[KerykeionPointModel]
-
-
-class AspectModel(SubscriptableBaseModel):
-    p1_name: str
-    p1_owner: str
-    p1_abs_pos: float
-    p2_name: str
-    p2_owner: str
-    p2_abs_pos: float
-    aspect: str
-    orbit: float
-    aspect_degrees: int
-    diff: float
-    p1: int
-    p2: int
-
-
-class ZodiacSignModel(SubscriptableBaseModel):
-    sign: Sign
-    quality: Quality
-    element: Element
-    emoji: SignsEmoji
-    sign_num: SignNumbers
-
-
-class RelationshipScoreAspectModel(SubscriptableBaseModel):
-    p1_name: str
-    p2_name: str
-    aspect: str
-    orbit: float
-
-
-class RelationshipScoreModel(SubscriptableBaseModel):
-    score_value: int
-    score_description: RelationshipScoreDescription
-    is_destiny_sign: bool
-    aspects: list[RelationshipScoreAspectModel]
-    subjects: list[AstrologicalSubjectModel]
-
-
-class CompositeSubjectModel(SubscriptableBaseModel):
-    """
-    Pydantic Model for Composite Subject
-    """
-
-    # Data
-    name: str
-    first_subject: AstrologicalSubjectModel
-    second_subject: AstrologicalSubjectModel
-    composite_chart_type: str
-
-    zodiac_type: ZodiacType
-    sidereal_mode: Union[SiderealMode, None]
-    houses_system_identifier: HousesSystemIdentifier
-    houses_system_name: str
-    perspective_type: PerspectiveType
-
-    # Planets
-    sun: KerykeionPointModel
-    moon: KerykeionPointModel
-    mercury: KerykeionPointModel
-    venus: KerykeionPointModel
-    mars: KerykeionPointModel
-    jupiter: KerykeionPointModel
-    saturn: KerykeionPointModel
-    uranus: KerykeionPointModel
-    neptune: KerykeionPointModel
-    pluto: KerykeionPointModel
-
-    # Axes
-    ascendant: KerykeionPointModel
-    descendant: KerykeionPointModel
-    medium_coeli: KerykeionPointModel
-    imum_coeli: KerykeionPointModel
-
-    # Optional Planets:
-    chiron: Union[KerykeionPointModel, None]
-    mean_lilith: Union[KerykeionPointModel, None]
-
-    # Houses
-    first_house: KerykeionPointModel
-    second_house: KerykeionPointModel
-    third_house: KerykeionPointModel
-    fourth_house: KerykeionPointModel
-    fifth_house: KerykeionPointModel
-    sixth_house: KerykeionPointModel
-    seventh_house: KerykeionPointModel
-    eighth_house: KerykeionPointModel
-    ninth_house: KerykeionPointModel
-    tenth_house: KerykeionPointModel
-    eleventh_house: KerykeionPointModel
-    twelfth_house: KerykeionPointModel
-
-    # Nodes
-    mean_node: KerykeionPointModel
-    true_node: KerykeionPointModel
-    mean_south_node: KerykeionPointModel
-    true_south_node: KerykeionPointModel
-
-    planets_names_list: list[Planet]
-    """Ordered list of available planets names"""
-
-    axial_cusps_names_list: list[AxialCusps]
-    """Ordered list of available axes names"""
-
-    houses_names_list: list[Houses]
-    """Ordered list of houses names"""
-
-    lunar_phase: LunarPhaseModel
-    """Lunar phase model"""
-
-
-class ActiveAspect(TypedDict):
-    name: AspectName
-    orb: int
-
-
-class TransitMomentModel(SubscriptableBaseModel):
-    """
-    Model representing a snapshot of astrological transits at a specific moment in time.
-
-    Captures all active aspects between moving celestial bodies and
-    the fixed positions in a person's natal chart at a specific date and time.
-
-    Attributes:
-        date: ISO 8601 formatted date and time of the transit moment.
-        aspects: List of astrological aspects active at this specific moment.
-    """
-
-    date: str
-    """ISO 8601 formatted date and time of the transit moment."""
-
-    aspects: list[AspectModel]
-    """List of aspects active at this specific moment."""
-
-
-class TransitsTimeRangeModel(SubscriptableBaseModel):
-    """
-    Model representing a collection of transit moments for an astrological subject.
-
-    This model holds a time series of transit snapshots, allowing analysis of
-    planetary movements and their aspects to a natal chart over a period of time.
-
-    Attributes:
-        transits: List of transit moments occurring during the specified time period.
-        subject: The astrological subject model for whom the transits are calculated.
-        dates: List of all dates in ISO 8601 format for which transits were calculated.
-    """
-
-    transits: list[TransitMomentModel]
-    """List of transit moments."""
-
-    subject: Optional[AstrologicalSubjectModel]
-    """Astrological subject data."""
-
-    dates: Optional[list[str]]
-    """ISO 8601 formatted dates of all transit moments."""
+# Re-export everything from schemas.kr_models for backward compatibility
+from kerykeion.schemas.kr_models import *  # noqa: F401, F403

kerykeion/kr_types/settings_models.py

@@ -1,208 +1,20 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2025 Giacomo Battaglia
-"""
-
-
-from pydantic import Field
-from typing import List, Optional, Union
-from kerykeion.kr_types.kr_models import SubscriptableBaseModel
-
-
-class KerykeionSettingsCelestialPointModel(SubscriptableBaseModel):
-    """
-    Defines the model for a celestial point data.
-    """
-
-    id: int = Field(title="Celestial Point ID", description="Celestial Point ID according to Pyswisseph")
-    name: str = Field(title="Celestial Point Name", description="Celestial Point Name")
-    color: str = Field(title="Celestial Point Color", description="Celestial Point Color, used in the chart")
-    element_points: int = Field(title="Celestial Point Element Points", description="Element Points given to the celestial point")
-    related_zodiac_signs: List[int] = Field(title="Celestial Point Related Zodiac Signs", description="Zodiac Signs related to the celestial point")
-    label: str = Field(title="Celestial Point Label", description="The name of the celestial point in the chart, it can be different from the name")
-    is_active: Optional[bool] = Field(title="Celestial Point is Active", description="Indicates if the celestial point is active in the chart", default=None)
-
-
-# Chart Colors Settings
-class KerykeionSettingsChartColorsModel(SubscriptableBaseModel):
-    """
-    Defines the model for the chart colors.
-    """
-
-    paper_0: str = Field(title="Paper Color 0", description="Paper Color 0")
-    paper_1: str = Field(title="Paper Color 1", description="Paper Color 1")
-    zodiac_bg_0: str = Field(title="Zodiac Background Color 0", description="Zodiac Background Color 0")
-    zodiac_bg_1: str = Field(title="Zodiac Background Color 1", description="Zodiac Background Color 1")
-    zodiac_bg_2: str = Field(title="Zodiac Background Color 2", description="Zodiac Background Color 2")
-    zodiac_bg_3: str = Field(title="Zodiac Background Color 3", description="Zodiac Background Color 3")
-    zodiac_bg_4: str = Field(title="Zodiac Background Color 4", description="Zodiac Background Color 4")
-    zodiac_bg_5: str = Field(title="Zodiac Background Color 5", description="Zodiac Background Color 5")
-    zodiac_bg_6: str = Field(title="Zodiac Background Color 6", description="Zodiac Background Color 6")
-    zodiac_bg_7: str = Field(title="Zodiac Background Color 7", description="Zodiac Background Color 7")
-    zodiac_bg_8: str = Field(title="Zodiac Background Color 8", description="Zodiac Background Color 8")
-    zodiac_bg_9: str = Field(title="Zodiac Background Color 9", description="Zodiac Background Color 9")
-    zodiac_bg_10: str = Field(title="Zodiac Background Color 10", description="Zodiac Background Color 10")
-    zodiac_bg_11: str = Field(title="Zodiac Background Color 11", description="Zodiac Background Color 11")
-    zodiac_icon_0: str = Field(title="Zodiac Icon Color 0", description="Zodiac Icon Color 0")
-    zodiac_icon_1: str = Field(title="Zodiac Icon Color 1", description="Zodiac Icon Color 1")
-    zodiac_icon_2: str = Field(title="Zodiac Icon Color 2", description="Zodiac Icon Color 2")
-    zodiac_icon_3: str = Field(title="Zodiac Icon Color 3", description="Zodiac Icon Color 3")
-    zodiac_icon_4: str = Field(title="Zodiac Icon Color 4", description="Zodiac Icon Color 4")
-    zodiac_icon_5: str = Field(title="Zodiac Icon Color 5", description="Zodiac Icon Color 5")
-    zodiac_icon_6: str = Field(title="Zodiac Icon Color 6", description="Zodiac Icon Color 6")
-    zodiac_icon_7: str = Field(title="Zodiac Icon Color 7", description="Zodiac Icon Color 7")
-    zodiac_icon_8: str = Field(title="Zodiac Icon Color 8", description="Zodiac Icon Color 8")
-    zodiac_icon_9: str = Field(title="Zodiac Icon Color 9", description="Zodiac Icon Color 9")
-    zodiac_icon_10: str = Field(title="Zodiac Icon Color 10", description="Zodiac Icon Color 10")
-    zodiac_icon_11: str = Field(title="Zodiac Icon Color 11", description="Zodiac Icon Color 11")
-    zodiac_radix_ring_0: str = Field(title="Zodiac Radix Ring Color 0", description="Zodiac Radix Ring Color 0")
-    zodiac_radix_ring_1: str = Field(title="Zodiac Radix Ring Color 1", description="Zodiac Radix Ring Color 1")
-    zodiac_radix_ring_2: str = Field(title="Zodiac Radix Ring Color 2", description="Zodiac Radix Ring Color 2")
-    zodiac_transit_ring_0: str = Field(title="Zodiac Transit Ring Color 0", description="Zodiac Transit Ring Color 0")
-    zodiac_transit_ring_1: str = Field(title="Zodiac Transit Ring Color 1", description="Zodiac Transit Ring Color 1")
-    zodiac_transit_ring_2: str = Field(title="Zodiac Transit Ring Color 2", description="Zodiac Transit Ring Color 2")
-    zodiac_transit_ring_3: str = Field(title="Zodiac Transit Ring Color 3", description="Zodiac Transit Ring Color 3")
-    houses_radix_line: str = Field(title="Houses Radix Line Color", description="Houses Radix Line Color")
-    houses_transit_line: str = Field(title="Houses Transit Line Color", description="Houses Transit Line Color")
-
-    # Deprecated: Not used anymore
-    lunar_phase_0: str = Field(title="Lunar Phase Color 0", description="Lunar Phase Color 0")
-    lunar_phase_1: str = Field(title="Lunar Phase Color 1", description="Lunar Phase Color 1")
-
-
-# Aspect Settings
-class KerykeionSettingsAspectModel(SubscriptableBaseModel):
-    """
-    Defines the model for an aspect.
-    """
-
-    degree: int = Field(title="Aspect Degrees", description="The degree of the aspect")
-    name: str = Field(title="Aspect Name", description="The name of the aspect")
-    color: str = Field(title="Aspect Color", description="The color of the aspect")
-    orb: Optional[int] = Field(title="Aspect Orb", description="The orb of the aspect", default=None)
-
-# Language Settings
-class KerykeionLanguageCelestialPointModel(SubscriptableBaseModel):
-    """
-    This class is used to define the labels, show in the chart, for the celestial points.
-    It is used to translate the celestial points in the language of the chart.
-    """
-
-    Sun: str = Field(title="Sun", description="The name of the Sun in the chart, in the language")
-    Moon: str = Field(title="Moon", description="The name of the Moon in the chart, in the language")
-    Mercury: str = Field(title="Mercury", description="The name of Mercury in the chart, in the language")
-    Venus: str = Field(title="Venus", description="The name of Venus in the chart, in the language")
-    Mars: str = Field(title="Mars", description="The name of Mars in the chart, in the language")
-    Jupiter: str = Field(title="Jupiter", description="The name of Jupiter in the chart, in the language")
-    Saturn: str = Field(title="Saturn", description="The name of Saturn in the chart, in the language")
-    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")
-    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")
-
-
-class KerykeionLanguageModel(SubscriptableBaseModel):
-    """
-    This model is used to store the language settings for the chart,
-    it's used to translate the celestial points and the other labels
-    """
-
-    info: str
-    cusp: str
-    longitude: str
-    latitude: str
-    north: str
-    east: str
-    south: str
-    west: str
-    fire: str
-    earth: str
-    air: str
-    water: str
-    and_word: str
-    transits: str
-    type: str
-    couple_aspects: str
-    transit_aspects: str
-    planets_and_house: str
-    transit_name: str
-    lunar_phase: str
-    day: str
-    celestial_points: KerykeionLanguageCelestialPointModel
-    composite_chart: str
-    midpoints: str
-    north_letter: str
-    east_letter: str
-    south_letter: str
-    west_letter: str
-    tropical: str
-    sidereal: str
-    zodiac: str
-    ayanamsa: str
-    apparent_geocentric: str
-    heliocentric: str
-    topocentric: str
-    true_geocentric: str
-    new_moon: str
-    waxing_crescent: str
-    first_quarter: str
-    waxing_gibbous: str
-    full_moon: str
-    waning_gibbous: str
-    last_quarter: str
-    waning_crescent: str
-    houses: str
-    houses_system_A: str
-    houses_system_B: str
-    houses_system_C: str
-    houses_system_D: str
-    houses_system_F: str
-    houses_system_H: str
-    houses_system_I: str
-    houses_system_i: str
-    houses_system_K: str
-    houses_system_L: str
-    houses_system_M: str
-    houses_system_N: str
-    houses_system_O: str
-    houses_system_P: str
-    houses_system_Q: str
-    houses_system_R: str
-    houses_system_S: str
-    houses_system_T: str
-    houses_system_U: str
-    houses_system_V: str
-    houses_system_W: str
-    houses_system_X: str
-    houses_system_Y: str
-    Natal: str
-    ExternalNatal: str
-    Synastry: str
-    Transit: str
-    Composite: str
-
-
-class KerykeionGeneralSettingsModel(SubscriptableBaseModel):
-    axes_orbit: int = Field(title="Axes Orbit", description="The orbit of the axes in the chart")
+Backward compatibility module for settings_models.
 
+DEPRECATED: This module will be removed in Kerykeion v6.0.
+Please update your imports:
+    OLD: from kerykeion.kr_types.settings_models import ...
+    NEW: from kerykeion.schemas.settings_models import ...
+"""
+import warnings
 
-# Settings Model
-class KerykeionSettingsModel(SubscriptableBaseModel):
-    """
-    This class is used to define the global settings for the Kerykeion.
-    """
+warnings.warn(
+    "The 'kerykeion.kr_types.settings_models' module is deprecated and will be removed in v6.0. "
+    "Please update your imports to use 'kerykeion.schemas.settings_models' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
 
-    chart_colors: KerykeionSettingsChartColorsModel = Field(title="Chart Colors", description="The colors of the chart")
-    celestial_points: List[KerykeionSettingsCelestialPointModel] = Field(title="Celestial Points", description="The list of the celestial points of the chart")
-    aspects: List[KerykeionSettingsAspectModel] = Field(title="Aspects", description="The list of the aspects of the chart")
-    language_settings: dict[str, KerykeionLanguageModel] = Field(title="Language Settings", description="The language settings of the chart")
-    general_settings: KerykeionGeneralSettingsModel = Field(title="General Settings", description="The general settings of the chart")
+# Re-export everything from schemas.settings_models for backward compatibility
+from kerykeion.schemas.settings_models import *  # noqa: F401, F403