kerykeion 4.5.1__tar.gz → 4.6.0__tar.gz

{kerykeion-4.5.1 → kerykeion-4.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kerykeion
-Version: 4.5.1
+Version: 4.6.0
 Summary: A python library for astrology.
 Home-page: https://github.com/g-battaglia/kerykeion
 License: AGPL-3.0

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 
     Kerykeion is a python library for Astrology.
     It can calculate all the planet and house position,

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/aspects/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-This is part of Kerykeion (C) 2023 Giacomo Battaglia
+This is part of Kerykeion (C) 2024 Giacomo Battaglia
 
 The aspects module contains the classes and functions for calculating 
  aspects between planets and points in a chart.

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/aspects/aspects_utils.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 # TODO: Better documentation and unit tests
 

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/aspects/natal_aspects.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 from pathlib import Path

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/aspects/synastry_aspects.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 from kerykeion import AstrologicalSubject

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/astrological_subject.py

@@ -1,9 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
-import math
 import pytz
 import swisseph as swe
 import logging
@@ -17,7 +16,13 @@ from kerykeion.kr_types import (
     LunarPhaseModel,
     KerykeionPointModel,
 )
-from kerykeion.utilities import get_number_from_name, calculate_position
+from kerykeion.utilities import (
+    get_number_from_name, 
+    calculate_position, 
+    get_planet_house,
+    get_moon_emoji_from_phase_int,
+    get_moon_phase_name_from_phase_int,
+)
 from pathlib import Path
 from typing import Union, Literal
 
@@ -431,64 +436,21 @@ class AstrologicalSubject:
         """Calculates the house of the planet and updates
         the planets dictionary."""
 
-        def for_every_planet(planet, planet_deg):
-            """Function to do the calculation.
-            Args: planet dictionary, planet degree"""
-
-            def point_between(p1, p2, p3):
-                """Finds if a point is between two other in a circle
-                args: first point, second point, point in the middle"""
-                p1_p2 = math.fmod(p2 - p1 + 360, 360)
-                p1_p3 = math.fmod(p3 - p1 + 360, 360)
-                if (p1_p2 <= 180) != (p1_p3 > p1_p2):
-                    return True
-                else:
-                    return False
-
-            if point_between(self.houses_degree_ut[0], self.houses_degree_ut[1], planet_deg) == True:
-                planet["house"] = "First_House"
-            elif point_between(self.houses_degree_ut[1], self.houses_degree_ut[2], planet_deg) == True:
-                planet["house"] = "Second_House"
-            elif point_between(self.houses_degree_ut[2], self.houses_degree_ut[3], planet_deg) == True:
-                planet["house"] = "Third_House"
-            elif point_between(self.houses_degree_ut[3], self.houses_degree_ut[4], planet_deg) == True:
-                planet["house"] = "Fourth_House"
-            elif point_between(self.houses_degree_ut[4], self.houses_degree_ut[5], planet_deg) == True:
-                planet["house"] = "Fifth_House"
-            elif point_between(self.houses_degree_ut[5], self.houses_degree_ut[6], planet_deg) == True:
-                planet["house"] = "Sixth_House"
-            elif point_between(self.houses_degree_ut[6], self.houses_degree_ut[7], planet_deg) == True:
-                planet["house"] = "Seventh_House"
-            elif point_between(self.houses_degree_ut[7], self.houses_degree_ut[8], planet_deg) == True:
-                planet["house"] = "Eighth_House"
-            elif point_between(self.houses_degree_ut[8], self.houses_degree_ut[9], planet_deg) == True:
-                planet["house"] = "Ninth_House"
-            elif point_between(self.houses_degree_ut[9], self.houses_degree_ut[10], planet_deg) == True:
-                planet["house"] = "Tenth_House"
-            elif point_between(self.houses_degree_ut[10], self.houses_degree_ut[11], planet_deg) == True:
-                planet["house"] = "Eleventh_House"
-            elif point_between(self.houses_degree_ut[11], self.houses_degree_ut[0], planet_deg) == True:
-                planet["house"] = "Twelfth_House"
-            else:
-                planet["house"] = "error!"
-
-            return planet
-
-        self.sun = for_every_planet(self.sun, self.planets_degrees_ut[0])
-        self.moon = for_every_planet(self.moon, self.planets_degrees_ut[1])
-        self.mercury = for_every_planet(self.mercury, self.planets_degrees_ut[2])
-        self.venus = for_every_planet(self.venus, self.planets_degrees_ut[3])
-        self.mars = for_every_planet(self.mars, self.planets_degrees_ut[4])
-        self.jupiter = for_every_planet(self.jupiter, self.planets_degrees_ut[5])
-        self.saturn = for_every_planet(self.saturn, self.planets_degrees_ut[6])
-        self.uranus = for_every_planet(self.uranus, self.planets_degrees_ut[7])
-        self.neptune = for_every_planet(self.neptune, self.planets_degrees_ut[8])
-        self.pluto = for_every_planet(self.pluto, self.planets_degrees_ut[9])
-        self.mean_node = for_every_planet(self.mean_node, self.planets_degrees_ut[10])
-        self.true_node = for_every_planet(self.true_node, self.planets_degrees_ut[11])
+        self.sun.house = get_planet_house(self.planets_degrees_ut[0], self.houses_degree_ut)
+        self.moon.house = get_planet_house(self.planets_degrees_ut[1], self.houses_degree_ut)
+        self.mercury.house = get_planet_house(self.planets_degrees_ut[2], self.houses_degree_ut)
+        self.venus.house = get_planet_house(self.planets_degrees_ut[3], self.houses_degree_ut)
+        self.mars.house = get_planet_house(self.planets_degrees_ut[4], self.houses_degree_ut)
+        self.jupiter.house = get_planet_house(self.planets_degrees_ut[5], self.houses_degree_ut)
+        self.saturn.house = get_planet_house(self.planets_degrees_ut[6], self.houses_degree_ut)
+        self.uranus.house = get_planet_house(self.planets_degrees_ut[7], self.houses_degree_ut)
+        self.neptune.house = get_planet_house(self.planets_degrees_ut[8], self.houses_degree_ut)
+        self.pluto.house = get_planet_house(self.planets_degrees_ut[9], self.houses_degree_ut)
+        self.mean_node.house = get_planet_house(self.planets_degrees_ut[10], self.houses_degree_ut)
+        self.true_node.house = get_planet_house(self.planets_degrees_ut[11], self.houses_degree_ut)
 
         if not self.disable_chiron:
-            self.chiron = for_every_planet(self.chiron, self.planets_degrees_ut[12])
+            self.chiron.house = get_planet_house(self.planets_degrees_ut[12], self.houses_degree_ut)
         else:
             self.chiron = None
 
@@ -583,33 +545,12 @@ class AstrologicalSubject:
             if degrees_between >= low and degrees_between < high:
                 sun_phase = x + 1
 
-        def moon_emoji(phase):
-            if phase == 1:
-                result = "🌑"
-            elif phase < 7:
-                result = "🌒"
-            elif 7 <= phase <= 9:
-                result = "🌓"
-            elif phase < 14:
-                result = "🌔"
-            elif phase == 14:
-                result = "🌕"
-            elif phase < 20:
-                result = "🌖"
-            elif 20 <= phase <= 22:
-                result = "🌗"
-            elif phase <= 28:
-                result = "🌘"
-            else:
-                result = phase
-
-            return result
-
         lunar_phase_dictionary = {
             "degrees_between_s_m": degrees_between,
             "moon_phase": moon_phase,
             "sun_phase": sun_phase,
-            "moon_emoji": moon_emoji(moon_phase),
+            "moon_emoji": get_moon_emoji_from_phase_int(moon_phase),
+            "moon_phase_name": get_moon_phase_name_from_phase_int(moon_phase)
         }
 
         self.lunar_phase = LunarPhaseModel(**lunar_phase_dictionary)

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/charts/__init__.py

@@ -1,5 +1,5 @@
 """
-This is part of Kerykeion (C) 2023 Giacomo Battaglia
+This is part of Kerykeion (C) 2024 Giacomo Battaglia
 
 This modules contains the charts logic for the Kerykeion project.
 """

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/charts/kerykeion_chart_svg.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/fetch_geonames.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/kr_types/__init__.py

@@ -1,3 +1,8 @@
+# -*- coding: utf-8 -*-
+"""
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
+"""
+
 from .kerykeion_exception import KerykeionException
 from .kr_literals import *
 from .kr_models import *

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/kr_types/kerykeion_exception.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/kr_types/kr_literals.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 
@@ -56,3 +56,13 @@ Quality = Literal[
 ChartType = Literal["Natal", "ExternalNatal", "Synastry", "Transit"]
 
 LunarPhaseEmoji = Literal["🌑", "🌒", "🌓", "🌔", "🌕", "🌖", "🌗", "🌘"]
+LunarPhaseName = Literal[
+        "New Moon", 
+        "Waxing Crescent", 
+        "First Quarter", 
+        "Waxing Gibbous", 
+        "Full Moon", 
+        "Waning Gibbous", 
+        "Last Quarter", 
+        "Waning Crescent"
+    ]

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/kr_types/kr_models.py

@@ -1,13 +1,13 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 
 from typing import Literal, Union, Optional
 from pydantic import BaseModel
 
-from .kr_literals import *
+from kerykeion.kr_types import LunarPhaseEmoji, LunarPhaseName, Planet, Houses, Quality, Element, Sign, ZodiacType
 
 
 class LunarPhaseModel(BaseModel):
@@ -15,11 +15,12 @@ class LunarPhaseModel(BaseModel):
     moon_phase: int
     sun_phase: int
     moon_emoji: LunarPhaseEmoji
+    moon_phase_name: LunarPhaseName
 
     def __str__(self):
         return (
             super()
-            .dict(
+            .model_dump(
                 exclude_none=True,
                 exclude_unset=True,
                 exclude_defaults=True,
@@ -73,7 +74,7 @@ class KerykeionPointModel(BaseModel):
     def __str__(self):
         return (
             super()
-            .dict(
+            .model_dump(
                 exclude_none=True,
                 exclude_unset=True,
                 exclude_defaults=True,
@@ -85,7 +86,7 @@ class KerykeionPointModel(BaseModel):
     def __repr__(self):
         return (
             super()
-            .dict(
+            .model_dump(
                 exclude_none=True,
                 exclude_unset=True,
                 exclude_defaults=True,
@@ -162,6 +163,7 @@ class AstrologicalSubjectModel(BaseModel):
 
 if __name__ == "__main__":
     from kerykeion.utilities import setup_logging
+
     setup_logging(level="debug")
 
     sun = KerykeionPointModel(
@@ -176,5 +178,5 @@ if __name__ == "__main__":
         point_type="Planet",
     )
 
-    print(sun.json())
+    print(sun.model_dump_json())
     print(sun)

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/kr_types/settings_models.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 
@@ -22,7 +22,7 @@ class CustomBaseModel(BaseModel):
         return getattr(self, item)
     
     def __str__(self) -> str:
-        return str(self.dict())
+        return str(self.model_dump())
 
     def get(self, item, default=None):
         return getattr(self, item, default)

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/relationship_score.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 from kerykeion import AstrologicalSubject

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/settings/kerykeion_settings.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 
@@ -60,7 +60,7 @@ def merge_settings(settings: KerykeionSettingsModel, new_settings: Dict) -> Kery
     Returns:
         KerykeionSettingsModel: The new settings
     """
-    new_settings_dict = settings.dict() | new_settings
+    new_settings_dict = settings.model_dump() | new_settings
     return KerykeionSettingsModel(**new_settings_dict)
 
 

{kerykeion-4.5.1 → kerykeion-4.6.0}/kerykeion/utilities.py

@@ -1,6 +1,9 @@
 from kerykeion.kr_types import KerykeionPointModel, KerykeionException, KerykeionSettingsModel, AstrologicalSubjectModel
+from kerykeion.kr_types.kr_literals import LunarPhaseEmoji, LunarPhaseName
 from typing import Union, Literal
 import logging
+import math
+
 
 
 def get_number_from_name(name: str) -> int:
@@ -220,3 +223,135 @@ def setup_logging(level: str) -> None:
     format: str = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
     loglevel: int = logopt.get(level, logging.INFO)
     logging.basicConfig(format=format, level=loglevel)
+
+def check_if_point_between(
+    start_point: Union[int, float], end_point: Union[int, float], evaluated_point: Union[int, float]
+) -> bool:
+    """
+    Finds if a point is between two other in a circle.
+
+    Args:
+        - start_point: The first point
+        - end_point: The second point
+        - point: The point to check if it is between start_point and end_point
+
+    Returns:
+        - True if point is between start_point and end_point, False otherwise
+    """
+
+    p1_p2 = math.fmod(end_point - start_point + 360, 360)
+    p1_p3 = math.fmod(evaluated_point - start_point + 360, 360)
+
+    if (p1_p2 <= 180) != (p1_p3 > p1_p2):
+        return True
+    else:
+        return False
+
+
+def get_planet_house(planet_position_degree: Union[int, float], houses_degree_ut_list: list) -> str:
+    """
+    Returns the house in which a planet is located.
+
+    Args:
+        - planet_position_degree: The position of the planet in degrees
+        - houses_degree_ut_list: A list of the houses in degrees (0-360)
+
+    Returns:
+        - The house in which the planet is located
+    """
+
+    house = None
+    if check_if_point_between(houses_degree_ut_list[0], houses_degree_ut_list[1], planet_position_degree) == True:
+        house = "First_House"
+    elif check_if_point_between(houses_degree_ut_list[1], houses_degree_ut_list[2], planet_position_degree) == True:
+        house = "Second_House"
+    elif check_if_point_between(houses_degree_ut_list[2], houses_degree_ut_list[3], planet_position_degree) == True:
+        house = "Third_House"
+    elif check_if_point_between(houses_degree_ut_list[3], houses_degree_ut_list[4], planet_position_degree) == True:
+        house = "Fourth_House"
+    elif check_if_point_between(houses_degree_ut_list[4], houses_degree_ut_list[5], planet_position_degree) == True:
+        house = "Fifth_House"
+    elif check_if_point_between(houses_degree_ut_list[5], houses_degree_ut_list[6], planet_position_degree) == True:
+        house = "Sixth_House"
+    elif check_if_point_between(houses_degree_ut_list[6], houses_degree_ut_list[7], planet_position_degree) == True:
+        house = "Seventh_House"
+    elif check_if_point_between(houses_degree_ut_list[7], houses_degree_ut_list[8], planet_position_degree) == True:
+        house = "Eighth_House"
+    elif check_if_point_between(houses_degree_ut_list[8], houses_degree_ut_list[9], planet_position_degree) == True:
+        house = "Ninth_House"
+    elif check_if_point_between(houses_degree_ut_list[9], houses_degree_ut_list[10], planet_position_degree) == True:
+        house = "Tenth_House"
+    elif check_if_point_between(houses_degree_ut_list[10], houses_degree_ut_list[11], planet_position_degree) == True:
+        house = "Eleventh_House"
+    elif check_if_point_between(houses_degree_ut_list[11], houses_degree_ut_list[0], planet_position_degree) == True:
+        house = "Twelfth_House"
+    else:
+        raise ValueError("Error in house calculation, planet: ", planet_position_degree)
+
+    return house
+
+def get_moon_emoji_from_phase_int(phase: int) -> LunarPhaseEmoji:
+    """
+    Returns the emoji of the moon phase.
+    
+    Args:
+        - phase: The phase of the moon (0-28)
+    
+    Returns:
+        - The emoji of the moon phase
+    """
+    
+    if phase == 1:
+        result = "🌑"
+    elif phase < 7:
+        result = "🌒"
+    elif 7 <= phase <= 9:
+        result = "🌓"
+    elif phase < 14:
+        result = "🌔"
+    elif phase == 14:
+        result = "🌕"
+    elif phase < 20:
+        result = "🌖"
+    elif 20 <= phase <= 22:
+        result = "🌗"
+    elif phase <= 28:
+        result = "🌘"
+
+    else:
+        raise KerykeionException(f"Error in moon emoji calculation! Phase: {phase}")
+
+    return result
+
+def get_moon_phase_name_from_phase_int(phase: int) -> LunarPhaseName:
+    """
+    Returns the name of the moon phase.
+    
+    Args:
+        - phase: The phase of the moon (0-28)
+    
+    Returns:
+        - The name of the moon phase
+    """
+    
+    if phase == 1:
+        result = "New Moon"
+    elif phase < 7:
+        result = "Waxing Crescent"
+    elif 7 <= phase <= 9:
+        result = "First Quarter"
+    elif phase < 14:
+        result = "Waxing Gibbous"
+    elif phase == 14:
+        result = "Full Moon"
+    elif phase < 20:
+        result = "Waning Gibbous"
+    elif 20 <= phase <= 22:
+        result = "Last Quarter"
+    elif phase <= 28:
+        result = "Waning Crescent"
+
+    else:
+        raise KerykeionException(f"Error in moon name calculation! Phase: {phase}")
+    
+    return result

{kerykeion-4.5.1 → kerykeion-4.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kerykeion"
-version = "4.5.1"
+version = "4.6.0"
 authors = ["Giacomo Battaglia <battaglia.giacomo@yahoo.it>"]
 description = "A python library for astrology."
 license = "AGPL-3.0"