kerykeion 4.24.7__py3-none-any.whl → 4.25.1__py3-none-any.whl

kerykeion/composite_subject_factory.py

@@ -0,0 +1,200 @@
+from typing import Union
+
+from kerykeion import AstrologicalSubject
+from kerykeion import KerykeionException
+from kerykeion.kr_types.kr_models import CompositeSubjectModel, AstrologicalSubjectModel
+from kerykeion.kr_types.kr_literals import ZodiacType, PerspectiveType, HousesSystemIdentifier, SiderealMode, Planet, Houses, AxialCusps, CompositeChartType
+from kerykeion.utilities import (
+    get_kerykeion_point_from_degree,
+    get_planet_house,
+    circular_mean,
+    calculate_moon_phase
+)
+
+
+class CompositeSubjectFactory:
+    """
+    Factory class to create a Composite Subject Model from two Astrological Subjects
+    Currently, the only available method for creating composite charts is the midpoint method.
+    The composite houses and planets are calculated based on the midpoint of the corresponding points of the two subjects.
+    The house are then reordered to match the original house system of the first subject.
+
+    Args:
+        first_subject (AstrologicalSubject): First astrological subject
+        second_subject (AstrologicalSubject): Second astrological subject
+        chart_name (str): Name of the composite chart. If None, it will be automatically generated.
+    """
+
+    model: Union[CompositeSubjectModel, None]
+    first_subject: AstrologicalSubjectModel
+    second_subject: AstrologicalSubjectModel
+    name: str
+    composite_chart_type: CompositeChartType
+    zodiac_type: ZodiacType
+    sidereal_mode: Union[SiderealMode, None]
+    houses_system_identifier: HousesSystemIdentifier
+    houses_system_name: str
+    perspective_type: PerspectiveType
+    planets_names_list: list[Planet]
+    houses_names_list: list[Houses]
+    axial_cusps_names_list: list[AxialCusps]
+
+    def __init__(
+            self,
+            first_subject: Union[AstrologicalSubject, AstrologicalSubjectModel],
+            second_subject: Union[AstrologicalSubject, AstrologicalSubjectModel],
+            chart_name: Union[str, None] = None
+    ):
+        self.model: Union[CompositeSubjectModel, None] = None
+        self.composite_chart_type = "Midpoint"
+
+        # Subjects
+        if isinstance(first_subject, AstrologicalSubject) or isinstance(first_subject, AstrologicalSubjectModel):
+            self.first_subject = first_subject.model() # type: ignore
+            self.second_subject = second_subject.model() # type: ignore
+        else:
+            self.first_subject = first_subject
+            self.second_subject = second_subject
+
+        # Name
+        if chart_name is None:
+            self.name = f"{first_subject.name} and {second_subject.name} Composite Chart"
+        else:
+            self.name = chart_name
+
+        # Zodiac Type
+        if first_subject.zodiac_type != second_subject.zodiac_type:
+            raise KerykeionException("Both subjects must have the same zodiac type")
+        self.zodiac_type = first_subject.zodiac_type
+
+        # Sidereal Mode
+        if first_subject.sidereal_mode != second_subject.sidereal_mode:
+            raise KerykeionException("Both subjects must have the same sidereal mode")
+
+        if first_subject.sidereal_mode is not None:
+            self.sidereal_mode = first_subject.sidereal_mode
+        else:
+            self.sidereal_mode = None
+
+        # Houses System
+        if first_subject.houses_system_identifier != second_subject.houses_system_identifier:
+            raise KerykeionException("Both subjects must have the same houses system")
+        self.houses_system_identifier = first_subject.houses_system_identifier
+
+        # Houses System Name
+        if first_subject.houses_system_name != second_subject.houses_system_name:
+            raise KerykeionException("Both subjects must have the same houses system name")
+        self.houses_system_name = first_subject.houses_system_name
+
+        # Perspective Type
+        if first_subject.perspective_type != second_subject.perspective_type:
+            raise KerykeionException("Both subjects must have the same perspective type")
+        self.perspective_type = first_subject.perspective_type
+
+        # Planets Names List
+        self.planets_names_list = []
+        for planet in first_subject.planets_names_list:
+            if planet in second_subject.planets_names_list:
+                self.planets_names_list.append(planet)
+
+        # Houses Names List
+        self.houses_names_list = self.first_subject.houses_names_list
+
+        # Axial Cusps Names List
+        self.axial_cusps_names_list = self.first_subject.axial_cusps_names_list
+
+    def __str__(self):
+        return f"Composite Chart Data for {self.name}"
+
+    def __repr__(self):
+        return f"Composite Chart Data for {self.name}"
+
+    def __eq__(self, other):
+        return self.first_subject == other.first_subject and self.second_subject == other.second_subject and self.name == other.chart_name
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __hash__(self):
+        return hash((self.first_subject, self.second_subject, self.name))
+
+    def __copy__(self):
+        return CompositeSubjectFactory(self.first_subject, self.second_subject, self.name)
+
+    def __setitem__(self, key, value):
+        setattr(self, key, value)
+
+    def __getitem__(self, key):
+        return getattr(self, key)
+
+    def _calculate_midpoint_composite_points_and_houses(self):
+        # Houses
+        house_degree_list_ut = []
+        for house in self.first_subject.houses_names_list:
+            house_lower = house.lower()
+            self[house_lower] = get_kerykeion_point_from_degree(
+                circular_mean(
+                    self.first_subject[house_lower]["abs_pos"],
+                    self.second_subject[house_lower]["abs_pos"]
+                ),
+                house,
+                "House"
+            )
+            house_degree_list_ut.append(self[house_lower]["abs_pos"])
+
+        house_degree_list_ut = sorted(house_degree_list_ut)
+
+        # Planets
+        common_planets = []
+        for planet in self.first_subject.planets_names_list:
+            if planet in self.second_subject.planets_names_list:
+                common_planets.append(planet)
+
+        planets = {}
+        for planet in common_planets:
+            planet_lower = planet.lower()
+            planets[planet_lower] = {}
+            planets[planet_lower]["abs_pos"] = circular_mean(
+                self.first_subject[planet_lower]["abs_pos"],
+                self.second_subject[planet_lower]["abs_pos"]
+            )
+            self[planet_lower] = get_kerykeion_point_from_degree(planets[planet_lower]["abs_pos"], planet, "Planet")
+            self[planet_lower]["house"] = get_planet_house(self[planet_lower]['abs_pos'], house_degree_list_ut)
+
+
+        # Axial Cusps
+        for cusp in self.first_subject.axial_cusps_names_list:
+            cusp_lower = cusp.lower()
+            self[cusp_lower] = get_kerykeion_point_from_degree(
+                circular_mean(
+                    self.first_subject[cusp_lower]["abs_pos"],
+                    self.second_subject[cusp_lower]["abs_pos"]
+                ),
+                cusp,
+                "AxialCusps"
+            )
+            self[cusp_lower]["house"] = get_planet_house(self[cusp_lower]['abs_pos'], house_degree_list_ut)
+
+    def _calculate_composite_lunar_phase(self):
+        self.lunar_phase = calculate_moon_phase(
+            self['moon'].abs_pos,
+            self['sun'].abs_pos
+        )
+
+    def get_midpoint_composite_subject_model(self):
+        self._calculate_midpoint_composite_points_and_houses()
+        self._calculate_composite_lunar_phase()
+
+        return CompositeSubjectModel(
+            **self.__dict__
+        )
+
+
+if __name__ == "__main__":
+    from kerykeion.astrological_subject import AstrologicalSubject
+
+    first = AstrologicalSubject("John Lennon", 1940, 10, 9, 18, 30, "Liverpool", "GB")
+    second = AstrologicalSubject("Paul McCartney", 1942, 6, 18, 15, 30, "Liverpool", "GB")
+
+    composite_chart = CompositeSubjectFactory(first, second)
+    print(composite_chart.get_midpoint_composite_subject_model().model_dump_json(indent=4))

kerykeion/kr_types/chart_types.py

@@ -13,18 +13,17 @@ class ChartTemplateDictionary(TypedDict):
     chart_width: float
     viewbox: str
     stringTitle: str
-    stringName: str
-    bottomLeft0: str
-    bottomLeft1: str
-    bottomLeft2: str
-    bottomLeft3: str
-    bottomLeft4: str
-    moon_phase: str
-    stringLocation: str
-    stringDateTime: str
-    stringLat: str
-    stringLon: str
-    stringPosition: str
+    top_left_0: str
+    bottom_left_0: str
+    bottom_left_1: str
+    bottom_left_2: str
+    bottom_left_3: str
+    bottom_left_4: str
+    top_left_1: str
+    top_left_2: str
+    top_left_3: str
+    top_left_4: str
+    top_left_5: str
 
     # Font color
     paper_color_0: str
@@ -81,8 +80,16 @@ class ChartTemplateDictionary(TypedDict):
     makeZodiac: str
     makeHouses: str
     makePlanets: str
-    elements_percentages: str
     makePlanetGrid: str
     makeHousesGrid: str
 
     color_style_tag: str
+
+    fire_string: str
+    earth_string: str
+    air_string: str
+    water_string: str
+
+    lunar_phase_rotate: str
+    lunar_phase_circle_center_x: str
+    lunar_phase_circle_radius: str

kerykeion/kr_types/kr_literals.py

@@ -40,7 +40,7 @@ Quality = Literal["Cardinal", "Fixed", "Mutable"]
 """Literal type for Qualities"""
 
 
-ChartType = Literal["Natal", "ExternalNatal", "Synastry", "Transit"]
+ChartType = Literal["Natal", "ExternalNatal", "Synastry", "Transit", "Composite"]
 """Literal type for Chart Types"""
 
 
@@ -114,9 +114,14 @@ KerykeionChartTheme = Literal["light", "dark", "dark-high-contrast", "classic"]
 KerykeionChartLanguage = Literal["EN", "FR", "PT", "IT", "CN", "ES", "RU", "TR", "DE", "HI"]
 """Literal type for Kerykeion Chart Languages"""
 
+
 RelationshipScoreDescription = Literal["Minimal", "Medium", "Important", "Very Important", "Exceptional", "Rare Exceptional"]
 """Literal type for Relationship Score Description"""
 
+
+CompositeChartType = Literal["Midpoint"]
+"""Literal type for Composite Chart Types"""
+
 AspectName = Literal[
     "conjunction",
     "semi-sextile",

kerykeion/kr_types/kr_models.py

@@ -25,7 +25,8 @@ from kerykeion.kr_types import (
     HousesSystemIdentifier,
     Houses,
     SignsEmoji,
-    RelationshipScoreDescription
+    RelationshipScoreDescription,
+    PerspectiveType
 )
 
 
@@ -74,6 +75,10 @@ class KerykeionPointModel(SubscriptableBaseModel):
 
 
 class AstrologicalSubjectModel(SubscriptableBaseModel):
+    """
+    Pydantic Model for Astrological Subject
+    """
+
     # Data
     name: str
     year: int
@@ -90,7 +95,7 @@ class AstrologicalSubjectModel(SubscriptableBaseModel):
     sidereal_mode: Union[SiderealMode, None]
     houses_system_identifier: HousesSystemIdentifier
     houses_system_name: str
-    perspective_type: str
+    perspective_type: PerspectiveType
     iso_formatted_local_datetime: str
     iso_formatted_utc_datetime: str
     julian_day: float
@@ -198,6 +203,78 @@ class RelationshipScoreModel(SubscriptableBaseModel):
     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

kerykeion/kr_types/settings_models.py

@@ -116,27 +116,78 @@ class KerykeionLanguageModel(SubscriptableBaseModel):
     it's used to translate the celestial points and the other labels
     """
 
-    info: str = Field(title="Info", description="The name of the Info label in the chart, in the language")
-    cusp: str = Field(title="Cusp", description="The name of the Cusp label in the chart, in the language")
-    longitude: str = Field(title="Longitude", description="The name of the Longitude label in the chart, in the language")
-    latitude: str = Field(title="Latitude", description="The name of the Latitude label in the chart, in the language")
-    north: str = Field(title="North", description="The name of the North label in the chart, in the language")
-    east: str = Field(title="East", description="The name of the East label in the chart, in the language")
-    south: str = Field(title="South", description="The name of the South label in the chart, in the language")
-    west: str = Field(title="West", description="The name of the West label in the chart, in the language")
-    fire: str = Field(title="Fire", description="The name of the Fire label in the chart, in the language")
-    earth: str = Field(title="Earth", description="The name of the Earth label in the chart, in the language")
-    air: str = Field(title="Air", description="The name of the Air label in the chart, in the language")
-    water: str = Field(title="Water", description="The name of the Water label in the chart, in the language")
-    and_word: str = Field(title="And", description="The name of the And word in the chart, in the language")
-    transits: str = Field(title="Transits", description="The name of the Transits label in the chart, in the language")
-    type: str = Field(title="Type", description="The name of the Type label in the chart, in the language")
-    aspects: str = Field(title="Aspects", description="The name of the Aspects label in the chart, in the language")
-    planets_and_house: str = Field(title="Planets and Houses", description="The name of the Planets and Houses label in the chart, in the language")
-    transit_name: str = Field(title="Transit Name", description="The name of the Transit Name label in the chart, in the language")
-    lunar_phase: str = Field(title="Lunar Phase", description="The name of the Lunar Phase label in the chart, in the language")
-    day: str = Field(title="Day", description="The name of the Day label in the chart, in the language")
+    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
+    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):

kerykeion/relationship_score/relationship_score_factory.py

@@ -221,57 +221,10 @@ if __name__ == "__main__":
 
     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))
+    giacomo = AstrologicalSubject("Giacomo", 1993, 6, 10, 12, 15, "Montichiari", "IT")
+    yoko = AstrologicalSubject("Susie Cox", 1949, 6, 17, 9, 40, "Tucson", "US")
+
+    factory = RelationshipScoreFactory(giacomo, yoko)
+    score = factory.get_relationship_score()
+    print(score)
+