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

kerykeion/kr_types/settings_models.py

@@ -68,7 +68,6 @@ class KerykeionSettingsChartColorsModel(SubscriptableBaseModel):
     # 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
@@ -80,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")
 
@@ -145,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):
@@ -162,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)

kerykeion/relationship_score/relationship_score_factory.py

@@ -0,0 +1,275 @@
+# -*- 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, RelationshipScoreAspectModel, RelationshipScoreModel
+from kerykeion.kr_types.kr_literals import RelationshipScoreDescription
+
+
+class RelationshipScoreFactory:
+    """
+    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 to 35: Exceptional relationship
+        - 30 and above: Rare Exceptional relationship
+
+    Documentation: http://www.cirodiscepolo.it/Articoli/Discepoloele.htm
+
+    Args:
+        first_subject (Union[AstrologicalSubject, AstrologicalSubjectModel]): First subject instance
+        second_subject (Union[AstrologicalSubject, AstrologicalSubjectModel]): Second subject instance
+    """
+
+    SCORE_MAPPING = [
+        ("Minimal", 5),
+        ("Medium", 10),
+        ("Important", 15),
+        ("Very Important", 20),
+        ("Exceptional", 30),
+        ("Rare Exceptional", float("inf")),
+    ]
+
+    def __init__(
+        self,
+        first_subject: Union[AstrologicalSubject, AstrologicalSubjectModel],
+        second_subject: Union[AstrologicalSubject, AstrologicalSubjectModel],
+        use_only_major_aspects: bool = True,
+    ):
+        if isinstance(first_subject, AstrologicalSubject):
+            self.first_subject = first_subject.model()
+        if isinstance(second_subject, AstrologicalSubject):
+            self.second_subject = second_subject.model()
+
+        self.use_only_major_aspects = use_only_major_aspects
+
+        self.score_value = 0
+        self.relationship_score_description: RelationshipScoreDescription = "Minimal"
+        self.is_destiny_sign = True
+        self.relationship_score_aspects: list[RelationshipScoreAspectModel] = []
+        self._synastry_aspects = SynastryAspects(self.first_subject, self.second_subject).all_aspects
+
+    def _evaluate_destiny_sign(self):
+        """
+        Evaluates if the subjects share the same sun sign quality and adds points if true.
+        """
+        if self.first_subject.sun["quality"] == self.second_subject.sun["quality"]:
+            self.is_destiny_sign = True
+            self.score_value += 5
+            logging.debug(f"Destiny sign found, adding 5 points, total score: {self.score_value}")
+
+    def _evaluate_aspect(self, aspect, points):
+        """
+        Evaluates an aspect and adds points to the score.
+
+        Args:
+            aspect (dict): Aspect information.
+            points (int): Points to add.
+        """
+        if self.use_only_major_aspects and not aspect["is_major"]:
+            return
+
+        self.score_value += points
+        self.relationship_score_aspects.append(
+            RelationshipScoreAspectModel(
+                p1_name=aspect["p1_name"],
+                p2_name=aspect["p2_name"],
+                aspect=aspect["aspect"],
+                orbit=aspect["orbit"],
+            )
+        )
+        logging.debug(f"{aspect['p1_name']}-{aspect['p2_name']} aspect: {aspect['aspect']} with orbit {aspect['orbit']} degrees, adding {points} points, total score: {self.score_value}, total aspects: {len(self.relationship_score_aspects)}")
+
+    def _evaluate_sun_sun_main_aspect(self, aspect):
+        """
+        Evaluates Sun-Sun main aspects and adds points accordingly:
+        - 8 points for conjunction/opposition/square
+        - 11 points if the aspect's orbit is <= 2 degrees
+
+        Args:
+            aspect (dict): Aspect information.
+        """
+        if aspect["p1_name"] == "Sun" and aspect["p2_name"] == "Sun" and aspect["aspect"] in {"conjunction", "opposition", "square"}:
+            points = 11 if aspect["orbit"] <= 2 else 8
+            self._evaluate_aspect(aspect, points)
+
+    def _evaluate_sun_moon_conjunction(self, aspect):
+        """
+        Evaluates Sun-Moon conjunctions and adds points accordingly:
+        - 8 points for conjunction
+        - 11 points if the aspect's orbit is <= 2 degrees
+
+        Args:
+            aspect (dict): Aspect information.
+        """
+        if {aspect["p1_name"], aspect["p2_name"]} == {"Moon", "Sun"} and aspect["aspect"] == "conjunction":
+            points = 11 if aspect["orbit"] <= 2 else 8
+            self._evaluate_aspect(aspect, points)
+
+    def _evaluate_sun_sun_other_aspects(self, aspect):
+        """
+        Evaluates Sun-Sun aspects that are not conjunctions and adds points accordingly:
+        - 4 points for other aspects
+
+        Args:
+            aspect (dict): Aspect information.
+        """
+        if aspect["p1_name"] == "Sun" and aspect["p2_name"] == "Sun" and aspect["aspect"] not in {"conjunction", "opposition", "square"}:
+            points = 4
+            self._evaluate_aspect(aspect, points)
+
+    def _evaluate_sun_moon_other_aspects(self, aspect):
+        """
+        Evaluates Sun-Moon aspects that are not conjunctions and adds points accordingly:
+        - 4 points for other aspects
+
+        Args:
+            aspect (dict): Aspect information.
+        """
+        if {aspect["p1_name"], aspect["p2_name"]} == {"Moon", "Sun"} and aspect["aspect"] != "conjunction":
+            points = 4
+            self._evaluate_aspect(aspect, points)
+
+    def _evaluate_sun_ascendant_aspect(self, aspect):
+        """
+        Evaluates Sun-Ascendant aspects and adds points accordingly:
+        - 4 points for any aspect
+
+        Args:
+            aspect (dict): Aspect information.
+        """
+        if {aspect["p1_name"], aspect["p2_name"]} == {"Sun", "First_House"}:
+            points = 4
+            self._evaluate_aspect(aspect, points)
+
+    def _evaluate_moon_ascendant_aspect(self, aspect):
+        """
+        Evaluates Moon-Ascendant aspects and adds points accordingly:
+        - 4 points for any aspect
+
+        Args:
+            aspect (dict): Aspect information.
+        """
+        if {aspect["p1_name"], aspect["p2_name"]} == {"Moon", "First_House"}:
+            points = 4
+            self._evaluate_aspect(aspect, points)
+
+    def _evaluate_venus_mars_aspect(self, aspect):
+        """
+        Evaluates Venus-Mars aspects and adds points accordingly:
+        - 4 points for any aspect
+
+        Args:
+            aspect (dict): Aspect information.
+        """
+        if {aspect["p1_name"], aspect["p2_name"]} == {"Venus", "Mars"}:
+            points = 4
+            self._evaluate_aspect(aspect, points)
+
+    def _evaluate_relationship_score_description(self):
+        """
+        Evaluates the relationship score description based on the total score.
+        """
+        for description, threshold in self.SCORE_MAPPING:
+            if self.score_value < threshold:
+                self.relationship_score_description = description
+                break
+
+    def get_relationship_score(self):
+        """
+        Calculates the relationship score based on synastry aspects.
+
+        Returns:
+            RelationshipScoreModel: The calculated relationship score.
+        """
+        self._evaluate_destiny_sign()
+
+        for aspect in self._synastry_aspects:
+            self._evaluate_sun_sun_main_aspect(aspect)
+            self._evaluate_sun_moon_conjunction(aspect)
+            self._evaluate_sun_moon_other_aspects(aspect)
+            self._evaluate_sun_sun_other_aspects(aspect)
+            self._evaluate_sun_ascendant_aspect(aspect)
+            self._evaluate_moon_ascendant_aspect(aspect)
+            self._evaluate_venus_mars_aspect(aspect)
+
+        self._evaluate_relationship_score_description()
+
+        return RelationshipScoreModel(
+            score_value=self.score_value,
+            score_description=self.relationship_score_description,
+            is_destiny_sign=self.is_destiny_sign,
+            aspects=self.relationship_score_aspects,
+            subjects=[self.first_subject, self.second_subject],
+        )
+
+
+if __name__ == "__main__":
+    from kerykeion.utilities import setup_logging
+
+    setup_logging(level="critical")
+
+    john = AstrologicalSubject("John", 1940, 10, 9, 18, 30, "Liverpool", "UK")
+    yoko = AstrologicalSubject("Yoko", 1933, 2, 18, 20, 30, "Tokyo", "JP")
+
+    relationship_score_factory = RelationshipScoreFactory(john, yoko)
+    relationship_score = relationship_score_factory.get_relationship_score()
+
+    print("John and Yoko relationship score:")
+    print(relationship_score.score_value)
+    print(relationship_score.score_description)
+    print(relationship_score.is_destiny_sign)
+    print(len(relationship_score.aspects))
+    print(len(relationship_score_factory._synastry_aspects))
+
+    print("------------------->")
+    freud = AstrologicalSubject("Freud", 1856, 5, 6, 18, 30, "Freiberg", "DE")
+    jung = AstrologicalSubject("Jung", 1875, 7, 26, 18, 30, "Kesswil", "CH")
+
+    relationship_score_factory = RelationshipScoreFactory(freud, jung)
+    relationship_score = relationship_score_factory.get_relationship_score()
+
+    print("Freud and Jung relationship score:")
+    print(relationship_score.score_value)
+    print(relationship_score.score_description)
+    print(relationship_score.is_destiny_sign)
+    print(len(relationship_score.aspects))
+    print(len(relationship_score_factory._synastry_aspects))
+
+    print("------------------->")
+    richart_burton = AstrologicalSubject("Richard Burton", 1925, 11, 10, 15, 00, "Pontrhydyfen", "UK")
+    liz_taylor = AstrologicalSubject("Elizabeth Taylor", 1932, 2, 27, 2, 30, "London", "UK")
+
+    relationship_score_factory = RelationshipScoreFactory(richart_burton, liz_taylor)
+    relationship_score = relationship_score_factory.get_relationship_score()
+
+    print("Richard Burton and Elizabeth Taylor relationship score:")
+    print(relationship_score.score_value)
+    print(relationship_score.score_description)
+    print(relationship_score.is_destiny_sign)
+    print(len(relationship_score.aspects))
+    print(len(relationship_score_factory._synastry_aspects))
+
+    print("------------------->")
+    dario_fo = AstrologicalSubject("Dario Fo", 1926, 3, 24, 12, 25, "Sangiano", "IT")
+    franca_rame = AstrologicalSubject("Franca Rame", 1929, 7, 18, 12, 25, "Parabiago", "IT")
+
+    relationship_score_factory = RelationshipScoreFactory(dario_fo, franca_rame)
+    relationship_score = relationship_score_factory.get_relationship_score()
+
+    print("Dario Fo and Franca Rame relationship score:")
+    print(relationship_score.score_value)
+    print(relationship_score.score_description)
+    print(relationship_score.is_destiny_sign)
+    print(len(relationship_score.aspects))
+    print(len(relationship_score_factory._synastry_aspects))

kerykeion/report.py

@@ -1,5 +1,8 @@
 from kerykeion import AstrologicalSubject
 from terminaltables import AsciiTable
+from kerykeion.utilities import get_houses_list, get_available_planets_list
+from typing import Union
+from kerykeion.kr_types.kr_models import AstrologicalSubjectModel
 
 class Report:
     """
@@ -11,7 +14,7 @@ class Report:
     planets_table: str
     houses_table: str
 
-    def __init__(self, instance: AstrologicalSubject):
+    def __init__(self, instance: Union[AstrologicalSubject, AstrologicalSubjectModel]):
         self.instance = instance
 
         self.get_report_title()
@@ -51,7 +54,7 @@ class Report:
                 ("R" if planet.retrograde else "-"),
                 planet.house,
             ]
-            for planet in self.instance.planets_list
+            for planet in get_available_planets_list(self.instance)
         ]
 
         self.planets_table = AsciiTable(planets_data).table
@@ -62,7 +65,7 @@ class Report:
         """
 
         houses_data = [["House", "Sign", "Position"]] + [
-            [house.name, house.sign, round(float(house.position), 2)] for house in self.instance.houses_list
+            [house.name, house.sign, round(float(house.position), 2)] for house in get_houses_list(self.instance)
         ]
 
         self.houses_table = AsciiTable(houses_data).table

kerykeion/settings/kerykeion_settings.py

@@ -11,7 +11,7 @@ from typing import Dict, Union
 from kerykeion.kr_types import KerykeionSettingsModel
 
 
-def get_settings(new_settings_file: Union[Path, None] = None) -> KerykeionSettingsModel:
+def get_settings(new_settings_file: Union[Path, None, KerykeionSettingsModel, dict] = None) -> KerykeionSettingsModel:
     """
     This function is used to get the settings dict from the settings file.
     If no settings file is passed as argument, or the file is not found, it will fallback to:
@@ -25,6 +25,11 @@ def get_settings(new_settings_file: Union[Path, None] = None) -> KerykeionSettin
         Dict: The settings dict
     """
 
+    if isinstance(new_settings_file, dict):
+        return KerykeionSettingsModel(**new_settings_file)
+    elif isinstance(new_settings_file, KerykeionSettingsModel):
+        return new_settings_file
+
     # Config path we passed as argument
     if new_settings_file is not None:
         settings_file = new_settings_file