kerykeion 4.12.3__py3-none-any.whl → 4.18.0__py3-none-any.whl

kerykeion/kr_types/chart_types.py

@@ -6,17 +6,11 @@ class ChartTemplateDictionary(TypedDict):
     degreeRing: str
     first_circle: str
     second_circle: str
-    c3: str
-    c3style: str
+    third_circle: str
     makeAspects: str
     makeAspectGrid: str
-    makePatterns: str
     chart_height: float
     chart_width: float
-    circleX: str
-    circleY: str
-    svgWidth: str
-    svgHeight: str
     viewbox: str
     stringTitle: str
     stringName: str
@@ -25,12 +19,7 @@ class ChartTemplateDictionary(TypedDict):
     bottomLeft2: str
     bottomLeft3: str
     bottomLeft4: str
-    lunar_phase_fg: str
-    lunar_phase_bg: str
-    lunar_phase_cx: int
-    lunar_phase_r: int
-    lunar_phase_outline: str
-    lunar_phase_rotate: float
+    moon_phase: str
     stringLocation: str
     stringDateTime: str
     stringLat: str
@@ -42,7 +31,7 @@ class ChartTemplateDictionary(TypedDict):
     # Background color of the chart
     paper_color_1: str
     
-    # Planets colors, from 1 to 15 (0 is the Sun)
+    # Planets colors, from 0 to 16 (0 is the Sun)
     planets_color_0: str
     planets_color_1: str
     planets_color_2: str
@@ -59,6 +48,7 @@ class ChartTemplateDictionary(TypedDict):
     planets_color_13: str
     planets_color_14: str
     planets_color_15: str
+    planets_color_16: str
     
     # Zodiac colors, from 0 to 11 (0 is Aries)
     zodiac_color_0: str
@@ -87,8 +77,6 @@ class ChartTemplateDictionary(TypedDict):
     orb_color_150: str
     orb_color_180: str
 
-    cfgZoom: str
-    cfgRotate: str
     cfgTranslate: str
     makeZodiac: str
     makeHouses: str
@@ -96,3 +84,5 @@ class ChartTemplateDictionary(TypedDict):
     elements_percentages: str
     makePlanetGrid: str
     makeHousesGrid: str
+
+    color_style_tag: str

kerykeion/kr_types/kr_literals.py

@@ -14,7 +14,7 @@ Sign = Literal["Ari", "Tau", "Gem", "Can", "Leo", "Vir", "Lib", "Sco", "Sag", "C
 
 
 SignNumbers = Literal[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
-"""Literal type for Zodiac Sign Numbers, the signs are numbered in order starting from Aries (0) to Pisces (11)"""
+"""Literal type for Zodiac Sign Numbers, the signs are numbered in order starting from Aries (0) to Pis (11)"""
 
 
 Houses = Literal["First_House", "Second_House", "Third_House", "Fourth_House", "Fifth_House", "Sixth_House", "Seventh_House", "Eighth_House", "Ninth_House", "Tenth_House", "Eleventh_House", "Twelfth_House"]
@@ -25,7 +25,7 @@ HouseNumbers = Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
 """Literal type for House Numbers, starting from the First House (1) to the Twelfth House (12)"""
 
 
-Planet = Literal["Sun", "Moon", "Mercury", "Venus", "Mars", "Jupiter", "Saturn", "Uranus", "Neptune", "Pluto", "Mean_Node", "True_Node", "Chiron"]
+Planet = Literal["Sun", "Moon", "Mercury", "Venus", "Mars", "Jupiter", "Saturn", "Uranus", "Neptune", "Pluto", "Mean_Node", "True_Node", "Chiron", "Mean_Lilith"]
 """Literal type for Planets"""
 
 
@@ -98,4 +98,13 @@ Literal type for perspective types.
 - "True Geocentric": Earth-centered, true positions.
 
 Usually the standard is "Apparent Geocentric"
-"""
+"""
+
+
+SignsEmoji = Literal["♈️", "♉️", "♊️", "♋️", "♌️", "♍️", "♎️", "♏️", "♐️", "♑️", "♒️", "♓️"]
+
+
+KerykeionChartTheme = Literal["light", "dark", "dark-high-contrast", "classic"]
+
+
+RelationshipScoreDescription = Literal["Minimal", "Medium", "Important", "Very Important", "Exceptional", "Rare Exceptional"]

kerykeion/kr_types/kr_models.py

@@ -7,12 +7,30 @@
 from typing import Union, Optional
 from pydantic import BaseModel
 
-from kerykeion.kr_types import LunarPhaseEmoji, LunarPhaseName, Planet, Houses, Quality, Element, Sign, ZodiacType, SignNumbers, HouseNumbers, PointType, SiderealMode, HousesSystemIdentifier
+from kerykeion.kr_types import (
+    LunarPhaseEmoji,
+    LunarPhaseName,
+    Planet,
+    Houses,
+    Quality,
+    Element,
+    Sign,
+    ZodiacType,
+    SignNumbers,
+    PointType,
+    SiderealMode,
+    HousesSystemIdentifier,
+    Houses,
+    SignsEmoji,
+    RelationshipScoreDescription
+)
+
 
 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)
 
@@ -22,9 +40,10 @@ class SubscriptableBaseModel(BaseModel):
     def __delitem__(self, key):
         delattr(self, key)
 
-    def get(self, key, default):
+    def get(self, key, default = None):
         return getattr(self, key, default)
 
+
 class LunarPhaseModel(SubscriptableBaseModel):
     degrees_between_s_m: Union[float, int]
     moon_phase: int
@@ -47,7 +66,7 @@ class KerykeionPointModel(SubscriptableBaseModel):
     abs_pos: float
     emoji: str
     point_type: PointType
-    house: Optional[HouseNumbers] = None
+    house: Optional[Houses] = None
     retrograde: Optional[bool] = None
 
 
@@ -73,6 +92,11 @@ class AstrologicalSubjectModel(SubscriptableBaseModel):
     iso_formatted_utc_datetime: str
     julian_day: float
 
+    # Deprecated properties -->
+    utc_time: float
+    local_time: float
+    # <-- Deprecated properties
+
     # Planets
     sun: KerykeionPointModel
     moon: KerykeionPointModel
@@ -87,6 +111,7 @@ class AstrologicalSubjectModel(SubscriptableBaseModel):
 
     # Optional Planets:
     chiron: Union[KerykeionPointModel, None]
+    mean_lilith: Union[KerykeionPointModel, None]
 
     # Houses
     first_house: KerykeionPointModel
@@ -106,35 +131,55 @@ class AstrologicalSubjectModel(SubscriptableBaseModel):
     mean_node: KerykeionPointModel
     true_node: KerykeionPointModel
 
-    # Lunar Phase
     lunar_phase: LunarPhaseModel
+    """Lunar phase model"""
+    
+    planets_names_list: list[Planet]
+    """Ordered list of available planets names"""
+
+    houses_names_list: list[Houses]
+    """Ordered list of houses names"""
+
+
+class EphemerisDictModel(SubscriptableBaseModel):
+    date: str
+    planets: list[KerykeionPointModel]
+    houses: list[KerykeionPointModel]
+
+
+class AspectModel(SubscriptableBaseModel):
+    p1_name: str
+    p1_abs_pos: float
+    p2_name: str
+    p2_abs_pos: float
+    aspect: str
+    orbit: float
+    aspect_degrees: int
+    aid: int
+    diff: float
+    p1: int
+    p2: int
+    is_major: bool
+
+
+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
 
-    # Deprecated properties
-    utc_time: float
-    local_time: float
 
-    # Lists
-    # houses_list: list[KerykeionPointModel]
-    # planets_list: list[KerykeionPointModel]
-    # planets_degrees_ut: list[float]
-    # houses_degree_ut: list[float]
-
-if __name__ == "__main__":
-    from kerykeion.utilities import setup_logging
-
-    setup_logging(level="debug")
-
-    sun = KerykeionPointModel(
-        name="Sun",
-        element="Air",
-        quality="Fixed",
-        sign="Aqu",
-        sign_num=1,
-        position=0,
-        abs_pos=12.123123,
-        emoji="♈",
-        point_type="Planet",
-    )
-
-    print(sun.model_dump_json())
-    print(sun)
+class RelationshipScoreModel(SubscriptableBaseModel):
+    score_value: int
+    score_description: RelationshipScoreDescription
+    is_destiny_sign: bool
+    aspects: list[RelationshipScoreAspectModel]
+    subjects: list[AstrologicalSubjectModel]

kerykeion/kr_types/settings_models.py

@@ -64,9 +64,10 @@ class KerykeionSettingsChartColorsModel(SubscriptableBaseModel):
     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")
-    lunar_phase_2: str = Field(title="Lunar Phase Color 2", description="Lunar Phase Color 2")
 
 
 # Aspect Settings
@@ -78,9 +79,7 @@ class KerykeionSettingsAspectModel(SubscriptableBaseModel):
     degree: int = Field(title="Aspect Degrees", description="The degree of the aspect")
     name: str = Field(title="Aspect Name", description="The name of the aspect")
     is_active: bool = Field(title="Aspect is Active", description="Is the aspect active?")
-    visible_grid: bool = Field(title="Aspect Visible Grid", description="Is the aspect visible in the grid?")
     is_major: bool = Field(title="Aspect is Major", description="Is the aspect major?")
-    is_minor: bool = Field(title="Aspect is Minor", description="Is the aspect minor?")
     orb: int = Field(title="Aspect Orb", description="The orb of the aspect")
     color: str = Field(title="Aspect Color", description="The color of the aspect")
 
@@ -109,6 +108,7 @@ class KerykeionLanguageCelestialPointModel(SubscriptableBaseModel):
     Mc: str = Field(title="Medium Coeli", description="The name of Medium Coeli in the chart, in the language")
     Dsc: str = Field(title="Descendant", description="The name of Descendant in the chart, in the language")
     Ic: 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")
 
 
 class KerykeionLanguageModel(SubscriptableBaseModel):
@@ -142,12 +142,7 @@ class KerykeionLanguageModel(SubscriptableBaseModel):
 
 class KerykeionGeneralSettingsModel(SubscriptableBaseModel):
     axes_orbit: int = Field(title="Axes Orbit", description="The orbit of the axes in the chart")
-    planet_in_zodiac_extra_points: int = Field(title="Planet in Zodiac Extra Points", description="The extra points of the planet in the zodiac")
-    language: str = Field(title="Language", description="The language of the chart")
 
-class KerykeionChartSettingsModel(SubscriptableBaseModel):
-    basic_chart_viewBox: str = Field(title="Basic Chart ViewBox", description="The viewbox of the basic chart")
-    wide_chart_viewBox: str = Field(title="Wide Chart ViewBox", description="The viewbox of the wide chart")
 
 # Settings Model
 class KerykeionSettingsModel(SubscriptableBaseModel):
@@ -159,5 +154,4 @@ class KerykeionSettingsModel(SubscriptableBaseModel):
     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")
-    chart_settings: KerykeionChartSettingsModel = Field(title="Chart Settings", description="The chart settings of the chart")
+    general_settings: KerykeionGeneralSettingsModel = Field(title="General Settings", description="The general settings of the chart")

kerykeion/relationship_score/__init__.py

@@ -0,0 +1,2 @@
+from .relationship_score import RelationshipScore
+from .relationship_score_factory import RelationshipScoreFactory

kerykeion/relationship_score/relationship_score.py

@@ -0,0 +1,175 @@
+# -*- coding: utf-8 -*-
+"""
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
+"""
+
+from kerykeion import AstrologicalSubject
+from kerykeion.aspects.synastry_aspects import SynastryAspects
+import logging
+from pathlib import Path
+from typing import Union
+from kerykeion.kr_types.kr_models import AstrologicalSubjectModel
+import warnings
+
+
+class RelationshipScore:
+    """
+    Calculates the relevance of the relationship between two subjects using the Ciro Discepolo method.
+
+    Results:
+        - 0 to 5: Minimal relationship
+        - 5 to 10: Medium relationship
+        - 10 to 15: Important relationship
+        - 15 to 20: Very important relationship
+        - 20 and 35: Exceptional relationship
+        - 35 and above: Rare Exceptional relationship
+
+    Documentation: http://www.cirodiscepolo.it/Articoli/Discepoloele.htm
+
+    Args:
+        first_subject (AstrologicalSubject): First subject instance
+        second_subject (AstrologicalSubject): Second subject instance
+    """
+
+    def __init__(
+        self,
+        first_subject: Union[AstrologicalSubject, AstrologicalSubjectModel],
+        second_subject: Union[AstrologicalSubject, AstrologicalSubjectModel],
+        new_settings_file: Union[Path, None] = None,
+    ):
+        warnings.warn(
+            "The RelationshipScore class is deprecated and will be removed in a future version. Use RelationshipScoreFactory instead.",
+            DeprecationWarning,
+            stacklevel=2
+        )
+        self.first_subject = first_subject
+        self.second_subject = second_subject
+        self.score = 0
+        self.is_destiny_sign = False
+        self.relevant_aspects: list = []
+        self.relevant_default_aspects: list = []
+        self.__all_synastry_aspects = SynastryAspects(first_subject, second_subject, new_settings_file=new_settings_file).all_aspects
+
+        # Calculate all aspects at initialization
+        self._calculate_all()
+
+    def __str__(self) -> str:
+        return f"CoupleScoreInstance: {self.first_subject.name} and {self.second_subject.name}, score: {self.score}"
+
+    def __dict__(self) -> dict: # type: ignore
+        return {
+            "first_subject_name": self.first_subject.name,
+            "second_subject_name": self.second_subject.name,
+            "score": self.score,
+            "relevant_aspects": self.relevant_aspects,
+            "relevant_default_aspects": self.relevant_default_aspects,
+            "is_destiny_sign": self.is_destiny_sign,
+        }
+
+    def _log_aspect(self, aspect: dict, points: int) -> None:
+        logging.debug(f"{points} Points: {aspect['p1_name']} {aspect['aspect']} {aspect['p2_name']}, rounded orbit: {int(aspect['orbit'])}")
+
+    def _evaluate_destiny_sign(self) -> int:
+        """
+        Adds 5 points if the subjects share the same sun sign quality.
+        """
+        if self.first_subject.sun["quality"] == self.second_subject.sun["quality"]:
+            logging.debug(f'5 points: Destiny sign, {self.first_subject.sun["sign"]} and {self.second_subject.sun["sign"]}')
+            self.is_destiny_sign = True
+            return 5
+        return 0
+
+    def _check_if_sun_sun_aspect(self, aspect: dict) -> int:
+        """
+        Adds points for Sun-Sun aspects:
+        - 8 points for conjunction/opposition/square
+        - 11 points if the aspect's orbit is <= 2 degrees
+        """
+        aspect_types = ["conjunction", "opposition", "square"]
+
+        if aspect["p1_name"] == "Sun" and aspect["p2_name"] == "Sun" and aspect["aspect"] in aspect_types:
+            self.relevant_default_aspects.append(aspect)
+            score = 11 if aspect["orbit"] <= 2 else 8
+
+            self._log_aspect(aspect, score)
+            self.relevant_aspects.append(self._create_aspects_dictionary(aspect, score))
+
+            return score
+        return 0
+
+    def _check_if_sun_moon_conjunction(self, aspect: dict) -> int:
+        """
+        Adds points for Sun-Moon conjunction:
+        - 8 points for conjunction
+        - 11 points if the aspect's orbit is <= 2 degrees
+        """
+        planets = {"Moon", "Sun"}
+
+        if {aspect["p1_name"], aspect["p2_name"]} == planets and aspect["aspect"] == "conjunction":
+            self.relevant_default_aspects.append(aspect)
+            score = 11 if aspect["orbit"] <= 2 else 8
+
+            self._log_aspect(aspect, score)
+            self.relevant_aspects.append(self._create_aspects_dictionary(aspect, score))
+
+            return score
+        return 0
+
+    def _check_if_sun_moon_asc_aspect(self, aspect: dict) -> int:
+        """
+        Adds 4 points for aspects involving Sun, Moon, and Ascendant.
+        """
+        planets = ["Sun", "Moon", "First_House"]
+
+        if self._check_if_sun_sun_aspect(aspect) or self._check_if_sun_moon_conjunction(aspect):
+            return 0
+
+        if aspect["p1_name"] in planets and aspect["p2_name"] in planets:
+            self.relevant_default_aspects.append(aspect)
+            score = 4
+
+            self._log_aspect(aspect, score)
+            self.relevant_aspects.append(self._create_aspects_dictionary(aspect, score))
+
+            return score
+        return 0
+
+    def _check_if_venus_mars_aspect(self, aspect: dict) -> int:
+        """
+        Adds 4 points for Venus-Mars aspects.
+        """
+        planets = {"Venus", "Mars"}
+
+        if {aspect["p1_name"], aspect["p2_name"]} == planets:
+            score = 4
+            self.relevant_default_aspects.append(aspect)
+
+            self._log_aspect(aspect, score)
+            self.relevant_aspects.append(self._create_aspects_dictionary(aspect, score))
+
+            return score
+        return 0
+
+    def _create_aspects_dictionary(self, aspect: dict, score: int) -> dict:
+        """
+        Creates a dictionary representation of an aspect with its score.
+        """
+        return {
+            "points": score,
+            "p1_name": aspect["p1_name"],
+            "p2_name": aspect["p2_name"],
+            "aspect": aspect["aspect"],
+            "orbit": aspect["orbit"],
+        }
+
+    def _calculate_all(self) -> None:
+        """
+        Calculates the total score based on all relevant aspects.
+        """
+        self.score += self._evaluate_destiny_sign()
+
+        for aspect in self.__all_synastry_aspects:
+            self.score += self._check_if_sun_sun_aspect(aspect)
+            self.score += self._check_if_sun_moon_conjunction(aspect)
+            self.score += self._check_if_sun_moon_asc_aspect(aspect)
+            self.score += self._check_if_venus_mars_aspect(aspect)