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

kerykeion/__init__.py

@@ -1,101 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
-
-    Kerykeion is a python library for Astrology.
-    It can calculate all the planet and house position,
-    also it can calculate the aspects of a single persone or between two, you can set how many planets you
-    need in the settings in the utility module.
-    It also can generate an SVG of a birthchart, a synastry chart or a transit chart.
-
-    Here some examples:
-
-    ```python
-
-    # Import the main class for creating a kerykeion instance:
-    >>> from kerykeion import AstrologicalSubject
-
-    # Create a kerykeion instance:
-    # Args: Name, year, month, day, hour, minuts, city, nation(optional)
-    >>> kanye = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta")
-
-    # Get the information about the sun in the chart:
-    # (The position of the planets always starts at 0)
-    >>> kanye.sun
-    {'name': 'Sun', 'quality': 'Mutable', 'element': 'Air', 'sign': 'Gem', 'sign_num': 2, 'pos': 17.598992059774275, 'abs_pos': 77.59899205977428, 'emoji': '♊️', 'house': '12th House', 'retrograde': False}
-
-    # Get informations about the first house:
-    >>> kanye.first_house
-    {'name': '1', 'quality': 'Cardinal', 'element': 'Water', 'sign': 'Can', 'sign_num': 3, 'pos': 17.995779673209114, 'abs_pos': 107.99577967320911, 'emoji': '♋️'}
-
-    # Get element of the moon sign:
-    >>> kanye.moon.get("element")
-    'Water'
-
-    ```
-
-    ## Generate a SVG of the birthchart:
-
-    ```python
-    >>> from kerykeion import AstrologicalSubject, KerykeionChartSVG
-
-    >>> first = AstrologicalSubject("Jack", 1990, 6, 15, 15, 15, "Roma")
-    >>> second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma")
-
-    # Set the type, it can be Natal, Synastry or Transit
-
-    >>> name = KerykeionChartSVG(first, chart_type="Synastry", second_obj=second)
-    >>> name.makeSVG()
-    >>> print(len(name.aspects_list))
-    >>> Generating kerykeion object for Jack...
-    Generating kerykeion object for Jane...
-    Jack birth location: Roma, 41.89193, 12.51133
-    SVG Generated Correctly
-    38
-
-    ```
-
-    ![alt text](http://centuryboy.altervista.org/JackSynastry_Chart.svg)
-
-
-    ## Other exeples of possibles usecase
-
-    ```python
-    # Get all aspects between two persons:
-
-    >>> from kerykeion import SynastryAspects, AstrologicalSubject
-    >>> first = AstrologicalSubject("Jack", 1990, 6, 15, 15, 15, "Roma")
-    >>> second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma")
-
-    >>> name = SynastryAspects(first, second)
-    >>> aspect_list = name.get_relevant_aspects()
-    >>> print(aspect_list[0])
-
-    Generating kerykeion object for Jack...
-    Generating kerykeion object for Jane...
-    {'p1_name': 'Sun', 'p1_abs_pos': 84.17867971515636, 'p2_name': 'Sun', 'p2_abs_pos': 211.90472999502984, 'aspect': 'trine', 'orbit': 7.726050279873476, 'aspect_degrees': 120, 'color': '#36d100', 'aid': 6, 'diff': 127.72605027987348, 'p1': 0, 'p2': 0}
-
-    ```
-
-    ## Documentation
-
-    Most of the functions and the classes are self documented by the types and have docstrings.
-    An auto-generated documentation [is available here](https://g-battaglia.github.io/kerykeion).
-
-    Sooner or later I'll try to write an extensive documentation.
-
-    ## Installation
-
-    Kerykeion is a Python 3 package, make sure you have Python 3 installed on your system.
-
-    ## Development
-
-    You can clone this repository or download a zip file using the right side buttons.
-
-    ## Contributing
-
-    Feel free to contribute to the code!
+This is part of Kerykeion (C) 2024 Giacomo Battaglia
 
+.. include:: ../README.md
 """
 
 # Local
@@ -105,4 +12,5 @@ from .kr_types import *
 from .relationship_score import RelationshipScore
 from .aspects import SynastryAspects, NatalAspects
 from .report import Report
-from .settings import KerykeionSettingsModel, get_settings_dict
+from .settings import KerykeionSettingsModel, get_settings
+from .enums import Planets, Aspects, Signs

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.
@@ -8,4 +8,4 @@ The aspects module contains the classes and functions for calculating
 
 
 from .synastry_aspects import SynastryAspects
-from .natal_aspects import NatalAspects
+from .natal_aspects import NatalAspects

kerykeion/aspects/aspects_utils.py

@@ -0,0 +1,174 @@
+# -*- coding: utf-8 -*-
+"""
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
+"""
+# TODO: Better documentation and unit tests
+
+from kerykeion import AstrologicalSubject
+from kerykeion.settings import KerykeionSettingsModel
+from swisseph import difdeg2n
+from typing import Union
+
+
+def get_aspect_from_two_points(aspects_settings: dict, point_one: Union[float, int], point_two: Union[float, int]):
+    """
+    Utility function.
+    It calculates the aspects between the 2 points.
+    Args: first point, second point.
+    """
+
+    distance = abs(difdeg2n(point_one, point_two))
+    diff = abs(point_one - point_two)
+
+    if int(distance) <= aspects_settings[0]["orb"]:
+        name = aspects_settings[0]["name"]
+        aspect_degrees = aspects_settings[0]["degree"]
+        verdict = True
+        aid = 0
+
+    elif (
+        (aspects_settings[1]["degree"] - aspects_settings[1]["orb"])
+        <= int(distance)
+        <= (aspects_settings[1]["degree"] + aspects_settings[1]["orb"])
+    ):
+        name = aspects_settings[1]["name"]
+        aspect_degrees = aspects_settings[1]["degree"]
+        verdict = True
+        aid = 1
+
+    elif (
+        (aspects_settings[2]["degree"] - aspects_settings[2]["orb"])
+        <= int(distance)
+        <= (aspects_settings[2]["degree"] + aspects_settings[2]["orb"])
+    ):
+        name = aspects_settings[2]["name"]
+        aspect_degrees = aspects_settings[2]["degree"]
+        verdict = True
+        aid = 2
+
+    elif (
+        (aspects_settings[3]["degree"] - aspects_settings[3]["orb"])
+        <= int(distance)
+        <= (aspects_settings[3]["degree"] + aspects_settings[3]["orb"])
+    ):
+        name = aspects_settings[3]["name"]
+        aspect_degrees = aspects_settings[3]["degree"]
+        verdict = True
+        aid = 3
+
+    elif (
+        (aspects_settings[4]["degree"] - aspects_settings[4]["orb"])
+        <= int(distance)
+        <= (aspects_settings[4]["degree"] + aspects_settings[4]["orb"])
+    ):
+        name = aspects_settings[4]["name"]
+        aspect_degrees = aspects_settings[4]["degree"]
+        verdict = True
+        aid = 4
+
+    elif (
+        (aspects_settings[5]["degree"] - aspects_settings[5]["orb"])
+        <= int(distance)
+        <= (aspects_settings[5]["degree"] + aspects_settings[5]["orb"])
+    ):
+        name = aspects_settings[5]["name"]
+        aspect_degrees = aspects_settings[5]["degree"]
+        verdict = True
+        aid = 5
+
+    elif (
+        (aspects_settings[6]["degree"] - aspects_settings[6]["orb"])
+        <= int(distance)
+        <= (aspects_settings[6]["degree"] + aspects_settings[6]["orb"])
+    ):
+        name = aspects_settings[6]["name"]
+        aspect_degrees = aspects_settings[6]["degree"]
+        verdict = True
+        aid = 6
+
+    elif (
+        (aspects_settings[7]["degree"] - aspects_settings[7]["orb"])
+        <= int(distance)
+        <= (aspects_settings[7]["degree"] + aspects_settings[7]["orb"])
+    ):
+        name = aspects_settings[7]["name"]
+        aspect_degrees = aspects_settings[7]["degree"]
+        verdict = True
+        aid = 7
+
+    elif (
+        (aspects_settings[8]["degree"] - aspects_settings[8]["orb"])
+        <= int(distance)
+        <= (aspects_settings[8]["degree"] + aspects_settings[8]["orb"])
+    ):
+        name = aspects_settings[8]["name"]
+        aspect_degrees = aspects_settings[8]["degree"]
+        verdict = True
+        aid = 8
+
+    elif (
+        (aspects_settings[9]["degree"] - aspects_settings[9]["orb"])
+        <= int(distance)
+        <= (aspects_settings[9]["degree"] + aspects_settings[9]["orb"])
+    ):
+        name = aspects_settings[9]["name"]
+        aspect_degrees = aspects_settings[9]["degree"]
+        verdict = True
+        aid = 9
+
+    elif (
+        (aspects_settings[10]["degree"] - aspects_settings[10]["orb"])
+        <= int(distance)
+        <= (aspects_settings[10]["degree"] + aspects_settings[10]["orb"])
+    ):
+        name = aspects_settings[10]["name"]
+        aspect_degrees = aspects_settings[10]["degree"]
+        verdict = True
+        aid = 10
+
+    else:
+        verdict = False
+        name = None
+        distance = 0
+        aspect_degrees = 0
+        color = None
+        aid = None
+
+    return (
+        verdict,
+        name,
+        distance - aspect_degrees,
+        aspect_degrees,
+        aid,
+        diff,
+    )
+
+
+def planet_id_decoder(planets_settings: dict, name: str):
+    """
+    Check if the name of the planet is the same in the settings and return
+    the correct id for the planet.
+    """
+    str_name = str(name)
+    for planet in planets_settings:
+        if planet["name"] == str_name:
+            result = planet["id"]
+            return result
+
+
+def get_active_points_list(subject: AstrologicalSubject, settings: Union[KerykeionSettingsModel, dict]) -> list:
+    """
+    Given an astrological subject and the settings, return a list of the active points.
+    Args:
+        subject (AstrologicalSubject): The astrological subject to get the active points from.
+        settings (Union[KerykeionSettingsModel, dict]): Settings model o dictionary.
+
+    Returns:
+        list: List of the active points.
+    """
+    point_list = []
+    for planet in settings["celestial_points"]:
+        if planet["is_active"] == True:
+            point_list.append(subject[planet["name"].lower()])
+
+    return point_list

kerykeion/aspects/natal_aspects.py

@@ -1,246 +1,76 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
-import json
 from pathlib import Path
 from kerykeion import AstrologicalSubject
-from swisseph import difdeg2n
+import logging
 from typing import Union
-from kerykeion.settings.kerykeion_settings import get_settings_dict
+from kerykeion.settings.kerykeion_settings import get_settings
+from dataclasses import dataclass
+from functools import cached_property
+from kerykeion.aspects.aspects_utils import planet_id_decoder, get_aspect_from_two_points, get_active_points_list
 
 
+AXES_LIST = [
+    "First_House",
+    "Tenth_House",
+    "Seventh_House",
+    "Fourth_House",
+]
+
+
+@dataclass
 class NatalAspects:
     """
     Generates an object with all the aspects of a birthcart.
     """
 
-    def __init__(self, kr_object: AstrologicalSubject, new_settings_file: Union[Path, None] = None):
-        self.user = kr_object
-        self.new_settings_file = new_settings_file
-        self._parse_json_settings()
-
-        self.init_point_list = self.user.planets_list + self.user.houses_list
-
-    def _parse_json_settings(self):
-        # Load settings file
-
-        settings = get_settings_dict(
-            self.new_settings_file,
-        )
-
-        self.planets_settings = settings["celestial_points"]
-        self.aspects_settings = settings["aspects"]
-        self.axes_orbit_settings = settings["general_settings"]["axes_orbit"]
-
-    def asp_calc(self, point_one, point_two):
-        """
-        Utility function.
-        It calculates the aspects between the 2 points.
-        Args: first point, second point.
-        """
-
-        distance = abs(difdeg2n(point_one, point_two))
-        diff = abs(point_one - point_two)
-
-        if int(distance) <= self.aspects_settings[0]["orb"]:
-            name = self.aspects_settings[0]["name"]
-            aspect_degrees = self.aspects_settings[0]["degree"]
-            color = self.aspects_settings[0]["color"]
-            verdict = True
-            aid = 0
-
-        elif (
-            (self.aspects_settings[1]["degree"] - self.aspects_settings[1]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[1]["degree"] + self.aspects_settings[1]["orb"])
-        ):
-            name = self.aspects_settings[1]["name"]
-            aspect_degrees = self.aspects_settings[1]["degree"]
-            color = self.aspects_settings[1]["color"]
-            verdict = True
-            aid = 1
-
-        elif (
-            (self.aspects_settings[2]["degree"] - self.aspects_settings[2]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[2]["degree"] + self.aspects_settings[2]["orb"])
-        ):
-            name = self.aspects_settings[2]["name"]
-            aspect_degrees = self.aspects_settings[2]["degree"]
-            color = self.aspects_settings[2]["color"]
-            verdict = True
-            aid = 2
-
-        elif (
-            (self.aspects_settings[3]["degree"] - self.aspects_settings[3]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[3]["degree"] + self.aspects_settings[3]["orb"])
-        ):
-            name = self.aspects_settings[3]["name"]
-            aspect_degrees = self.aspects_settings[3]["degree"]
-            color = self.aspects_settings[3]["color"]
-            verdict = True
-            aid = 3
-
-        elif (
-            (self.aspects_settings[4]["degree"] - self.aspects_settings[4]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[4]["degree"] + self.aspects_settings[4]["orb"])
-        ):
-            name = self.aspects_settings[4]["name"]
-            aspect_degrees = self.aspects_settings[4]["degree"]
-            color = self.aspects_settings[4]["color"]
-            verdict = True
-            aid = 4
-
-        elif (
-            (self.aspects_settings[5]["degree"] - self.aspects_settings[5]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[5]["degree"] + self.aspects_settings[5]["orb"])
-        ):
-            name = self.aspects_settings[5]["name"]
-            aspect_degrees = self.aspects_settings[5]["degree"]
-            color = self.aspects_settings[5]["color"]
-            verdict = True
-            aid = 5
+    user: AstrologicalSubject
+    new_settings_file: Union[Path, None] = None
 
-        elif (
-            (self.aspects_settings[6]["degree"] - self.aspects_settings[6]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[6]["degree"] + self.aspects_settings[6]["orb"])
-        ):
-            name = self.aspects_settings[6]["name"]
-            aspect_degrees = self.aspects_settings[6]["degree"]
-            color = self.aspects_settings[6]["color"]
-            verdict = True
-            aid = 6
+    def __post_init__(self):
+        self.settings = get_settings(self.new_settings_file)
 
-        elif (
-            (self.aspects_settings[7]["degree"] - self.aspects_settings[7]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[7]["degree"] + self.aspects_settings[7]["orb"])
-        ):
-            name = self.aspects_settings[7]["name"]
-            aspect_degrees = self.aspects_settings[7]["degree"]
-            color = self.aspects_settings[7]["color"]
-            verdict = True
-            aid = 7
+        self.celestial_points = self.settings["celestial_points"]
+        self.aspects_settings = self.settings["aspects"]
+        self.axes_orbit_settings = self.settings["general_settings"]["axes_orbit"]
 
-        elif (
-            (self.aspects_settings[8]["degree"] - self.aspects_settings[8]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[8]["degree"] + self.aspects_settings[8]["orb"])
-        ):
-            name = self.aspects_settings[8]["name"]
-            aspect_degrees = self.aspects_settings[8]["degree"]
-            color = self.aspects_settings[8]["color"]
-            verdict = True
-            aid = 8
-
-        elif (
-            (self.aspects_settings[9]["degree"] - self.aspects_settings[9]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[9]["degree"] + self.aspects_settings[9]["orb"])
-        ):
-            name = self.aspects_settings[9]["name"]
-            aspect_degrees = self.aspects_settings[9]["degree"]
-            color = self.aspects_settings[9]["color"]
-            verdict = True
-            aid = 9
-
-        elif (
-            (self.aspects_settings[10]["degree"] - self.aspects_settings[10]["orb"])
-            <= int(distance)
-            <= (self.aspects_settings[10]["degree"] + self.aspects_settings[10]["orb"])
-        ):
-            name = self.aspects_settings[10]["name"]
-            aspect_degrees = self.aspects_settings[10]["degree"]
-            color = self.aspects_settings[10]["color"]
-            verdict = True
-            aid = 10
-
-        else:
-            verdict = False
-            name = None
-            distance = 0
-            aspect_degrees = 0
-            color = None
-            aid = None
-
-        return (
-            verdict,
-            name,
-            distance - aspect_degrees,
-            aspect_degrees,
-            color,
-            aid,
-            diff,
-        )
-
-    def p_id_decoder(self, name):
-        """
-        Check if the name of the planet is the same in the settings and return
-        the correct id for the planet.
-        """
-        str_name = str(name)
-        for planet in self.planets_settings:
-            if planet["name"] == str_name:
-                result = planet["id"]
-                return result
-
-    def filter_by_settings(self, init_point_list):
-        """
-        Creates a list of all the desired
-        points filtering by the settings.
-        """
-
-        set_points_name = []
-        for p in self.planets_settings:
-            if p["is_active"]:
-                set_points_name.append(p["name"])
-
-        point_list = []
-        for l in init_point_list:
-            if l["name"] in set_points_name:
-                point_list.append(l)
-
-        return point_list
-
-    def get_all_aspects(self):
+    @cached_property
+    def all_aspects(self):
         """
         Return all the aspects of the points in the natal chart in a dictionary,
         first all the individual aspects of each planet, second the aspects
-        whitout repetitions.
+        without repetitions.
         """
 
-        point_list = self.filter_by_settings(self.init_point_list)
+        active_points_list = get_active_points_list(self.user, self.settings)
 
         self.all_aspects_list = []
 
-        for first in range(len(point_list)):
-            # Generates the aspects list whitout repetitions
-            for second in range(first + 1, len(point_list)):
-                verdict, name, orbit, aspect_degrees, color, aid, diff = self.asp_calc(
-                    point_list[first]["abs_pos"], point_list[second]["abs_pos"]
+        for first in range(len(active_points_list)):
+            # Generates the aspects list without repetitions
+            for second in range(first + 1, len(active_points_list)):
+                verdict, name, orbit, aspect_degrees, aid, diff = get_aspect_from_two_points(
+                    self.aspects_settings, active_points_list[first]["abs_pos"], active_points_list[second]["abs_pos"]
                 )
 
                 if verdict == True:
                     d_asp = {
-                        "p1_name": point_list[first]["name"],
-                        "p1_abs_pos": point_list[first]["abs_pos"],
-                        "p2_name": point_list[second]["name"],
-                        "p2_abs_pos": point_list[second]["abs_pos"],
+                        "p1_name": active_points_list[first]["name"],
+                        "p1_abs_pos": active_points_list[first]["abs_pos"],
+                        "p2_name": active_points_list[second]["name"],
+                        "p2_abs_pos": active_points_list[second]["abs_pos"],
                         "aspect": name,
                         "orbit": orbit,
                         "aspect_degrees": aspect_degrees,
-                        "color": color,
                         "aid": aid,
                         "diff": diff,
-                        "p1": self.p_id_decoder(point_list[first]["name"]),
-                        "p2": self.p_id_decoder(
-                            point_list[second]["name"],
+                        "p1": planet_id_decoder(self.celestial_points, active_points_list[first]["name"]),
+                        "p2": planet_id_decoder(
+                            self.celestial_points,
+                            active_points_list[second]["name"],
                         ),
                     }
 
@@ -248,7 +78,8 @@ class NatalAspects:
 
         return self.all_aspects_list
 
-    def get_relevant_aspects(self):
+    @cached_property
+    def relevant_aspects(self):
         """
         Filters the aspects list with the desired points, in this case
         the most important are hardcoded.
@@ -256,19 +87,15 @@ class NatalAspects:
         or the numbers of the houses.
         """
 
-        self.get_all_aspects()
+        logging.debug("Relevant aspects not already calculated, calculating now...")
+        self.all_aspects
 
         aspects_filtered = []
         for a in self.all_aspects_list:
             if self.aspects_settings[a["aid"]]["is_active"] == True:
                 aspects_filtered.append(a)
 
-        axes_list = [
-            "First_House",
-            "Tenth_House",
-            "Seventh_House",
-            "Fourth_House",
-        ]
+        axes_list = AXES_LIST
         counter = 0
 
         aspects_list_subtract = []
@@ -291,15 +118,17 @@ class NatalAspects:
 
 
 if __name__ == "__main__":
+    from kerykeion.utilities import setup_logging
+    setup_logging(level="debug")
+
     johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US")
 
     # All aspects
-    aspects = NatalAspects(johnny).get_all_aspects()
-    print(aspects)
+    aspects = NatalAspects(johnny)
+    print(aspects.all_aspects)
 
     print("\n")
 
     # Relevant aspects
-    aspects = NatalAspects(johnny).get_relevant_aspects()
-    print(aspects)
-
+    aspects = NatalAspects(johnny)
+    print(aspects.relevant_aspects)