kerykeion 4.0.7__tar.gz → 4.1.1__tar.gz

{kerykeion-4.0.7 → kerykeion-4.1.1}/PKG-INFO

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

{kerykeion-4.0.7 → kerykeion-4.1.1}/kerykeion/__init__.py

@@ -68,7 +68,7 @@
     >>> second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma")
 
     >>> name = SynastryAspects(first, second)
-    >>> aspect_list = name.get_relevant_aspects()
+    >>> aspect_list = name.relevant_aspects
     >>> print(aspect_list[0])
 
     Generating kerykeion object for Jack...
@@ -105,4 +105,4 @@ 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

kerykeion-4.1.1/kerykeion/aspects/aspects_utils.py

@@ -0,0 +1,185 @@
+# -*- coding: utf-8 -*-
+"""
+    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+"""
+# TODO: Better documentation and unit tests
+
+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"]
+        color = aspects_settings[0]["color"]
+        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"]
+        color = aspects_settings[1]["color"]
+        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"]
+        color = aspects_settings[2]["color"]
+        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"]
+        color = aspects_settings[3]["color"]
+        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"]
+        color = aspects_settings[4]["color"]
+        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"]
+        color = aspects_settings[5]["color"]
+        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"]
+        color = aspects_settings[6]["color"]
+        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"]
+        color = aspects_settings[7]["color"]
+        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"]
+        color = aspects_settings[8]["color"]
+        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"]
+        color = aspects_settings[9]["color"]
+        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"]
+        color = 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 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 filter_by_settings(planets_settings: dict, init_point_list: list):
+    """
+    Creates a list of all the desired
+    points filtering by the settings.
+    """
+
+    set_points_name = []
+    for p in 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

kerykeion-4.1.1/kerykeion/aspects/natal_aspects.py

@@ -0,0 +1,143 @@
+# -*- coding: utf-8 -*-
+"""
+    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+"""
+
+from pathlib import Path
+from kerykeion import AstrologicalSubject
+from logging import getLogger, basicConfig
+from typing import Union
+from kerykeion.settings.kerykeion_settings import get_settings
+from dataclasses import dataclass
+from kerykeion.aspects.aspects_utils import filter_by_settings, planet_id_decoder, get_aspect_from_two_points
+
+logger = getLogger(__name__)
+basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level="INFO")
+
+
+@dataclass
+class NatalAspects:
+    """
+    Generates an object with all the aspects of a birthcart.
+    """
+
+    user: AstrologicalSubject
+    new_settings_file: Union[Path, None] = None
+    _all_aspects: Union[list, None] = None
+    _relevant_aspects: Union[list, None] = None
+
+    def __post_init__(self):
+        settings = get_settings(self.new_settings_file)
+
+        self.init_point_list = self.user.planets_list + self.user.houses_list
+
+        self.planets_settings = settings["celestial_points"]
+        self.aspects_settings = settings["aspects"]
+        self.axes_orbit_settings = settings["general_settings"]["axes_orbit"]
+
+    @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
+        without repetitions.
+        """
+
+        if self._all_aspects is not None:
+            return self._all_aspects
+
+        point_list = filter_by_settings(self.planets_settings, self.init_point_list)
+
+        self.all_aspects_list = []
+
+        for first in range(len(point_list)):
+            # Generates the aspects list without repetitions
+            for second in range(first + 1, len(point_list)):
+                verdict, name, orbit, aspect_degrees, color, aid, diff = get_aspect_from_two_points(
+                    self.aspects_settings, point_list[first]["abs_pos"], point_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"],
+                        "aspect": name,
+                        "orbit": orbit,
+                        "aspect_degrees": aspect_degrees,
+                        "color": color,
+                        "aid": aid,
+                        "diff": diff,
+                        "p1": planet_id_decoder(self.planets_settings, point_list[first]["name"]),
+                        "p2": planet_id_decoder(
+                            self.planets_settings,
+                            point_list[second]["name"],
+                        ),
+                    }
+
+                    self.all_aspects_list.append(d_asp)
+
+        return self.all_aspects_list
+
+    @property
+    def relevant_aspects(self):
+        """
+        Filters the aspects list with the desired points, in this case
+        the most important are hardcoded.
+        Set the list with set_points and creating a list with the names
+        or the numbers of the houses.
+        """
+
+        if self._relevant_aspects is not None:
+            logger.debug("Relevant aspects already calculated, returning cached value")
+            return self._relevant_aspects
+
+        logger.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",
+        ]
+        counter = 0
+
+        aspects_list_subtract = []
+        for a in aspects_filtered:
+            counter += 1
+            name_p1 = str(a["p1_name"])
+            name_p2 = str(a["p2_name"])
+
+            if name_p1 in axes_list:
+                if abs(a["orbit"]) >= self.axes_orbit_settings:
+                    aspects_list_subtract.append(a)
+
+            elif name_p2 in axes_list:
+                if abs(a["orbit"]) >= self.axes_orbit_settings:
+                    aspects_list_subtract.append(a)
+
+        self.aspects = [item for item in aspects_filtered if item not in aspects_list_subtract]
+
+        return self.aspects
+
+
+if __name__ == "__main__":
+    basicConfig(level="DEBUG", force=True)
+    johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US")
+
+    # All aspects
+    aspects = NatalAspects(johnny)
+    print(aspects.all_aspects)
+
+    print("\n")
+
+    # Relevant aspects
+    aspects = NatalAspects(johnny)
+    print(aspects.relevant_aspects)

{kerykeion-4.0.7 → kerykeion-4.1.1}/kerykeion/aspects/synastry_aspects.py

@@ -8,6 +8,8 @@ from pathlib import Path
 from typing import Union
 
 from kerykeion.aspects.natal_aspects import NatalAspects
+from kerykeion.settings.kerykeion_settings import get_settings
+from kerykeion.aspects.aspects_utils import filter_by_settings, planet_id_decoder, get_aspect_from_two_points
 
 
 class SynastryAspects(NatalAspects):
@@ -25,28 +27,41 @@ class SynastryAspects(NatalAspects):
         self.second_user = kr_object_two
 
         self.new_settings_file = new_settings_file
-        self._parse_json_settings()
 
         self.first_init_point_list = self.first_user.planets_list + self.first_user.houses_list
         self.second_init_point_list = self.second_user.planets_list + self.second_user.houses_list
 
-    def get_all_aspects(self):
+        self._all_aspects: Union[list, None] = None
+        self._relevant_aspects: Union[list, None] = None
+
+        settings = get_settings(self.new_settings_file)
+
+        self.planets_settings = settings["celestial_points"]
+        self.aspects_settings = settings["aspects"]
+        self.axes_orbit_settings = settings["general_settings"]["axes_orbit"]
+
+    @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
         whiteout repetitions.
         """
 
-        f_1 = self.filter_by_settings(self.first_init_point_list)
-        f_2 = self.filter_by_settings(self.second_init_point_list)
+        if self._all_aspects is not None:
+            return self._all_aspects
+
+        f_1 = filter_by_settings(self.planets_settings, self.first_init_point_list)
+
+        f_2 = filter_by_settings(self.planets_settings, self.second_init_point_list)
 
         self.all_aspects_list = []
 
         for first in range(len(f_1)):
             # Generates the aspects list whitout repetitions
             for second in range(len(f_2)):
-                verdict, name, orbit, aspect_degrees, color, aid, diff = self.asp_calc(
-                    f_1[first]["abs_pos"], f_2[second]["abs_pos"]
+                verdict, name, orbit, aspect_degrees, color, aid, diff = get_aspect_from_two_points(
+                    self.aspects_settings, f_1[first]["abs_pos"], f_2[second]["abs_pos"]
                 )
 
                 if verdict == True:
@@ -61,8 +76,9 @@ class SynastryAspects(NatalAspects):
                         "color": color,
                         "aid": aid,
                         "diff": diff,
-                        "p1": self.p_id_decoder(f_1[first]["name"]),
-                        "p2": self.p_id_decoder(
+                        "p1": planet_id_decoder(self.planets_settings, f_1[first]["name"]),
+                        "p2": planet_id_decoder(
+                            self.planets_settings,
                             f_2[second]["name"],
                         ),
                     }
@@ -79,7 +95,7 @@ if __name__ == "__main__":
     synastry_aspects = SynastryAspects(john, yoko)
 
     # All aspects
-    print(synastry_aspects.get_all_aspects())
+    print(synastry_aspects.all_aspects)
 
     # Relevant aspects
-    print(synastry_aspects.get_relevant_aspects())
+    print(synastry_aspects.relevant_aspects)

{kerykeion-4.0.7 → kerykeion-4.1.1}/kerykeion/astrological_subject.py

@@ -21,6 +21,7 @@ from kerykeion.utilities import get_number_from_name, calculate_position
 from pathlib import Path
 from typing import Union, Literal
 
+DEFAULT_GEONAMES_USERNAME = "century.boy"
 
 logger = getLogger(__name__)
 basicConfig(
@@ -131,7 +132,7 @@ class AstrologicalSubject:
         lng: Union[int, float] = 0,
         lat: Union[int, float] = 0,
         tz_str: str = "",
-        geonames_username: str = "century.boy",
+        geonames_username: Union[str, None] = None,
         zodiac_type: ZodiacType = "Tropic",
         online: bool = True,
     ) -> None:
@@ -144,7 +145,6 @@ class AstrologicalSubject:
             )
         )
 
-
         self.name = name
         self.year = year
         self.month = month
@@ -156,10 +156,31 @@ class AstrologicalSubject:
         self.lng = lng
         self.lat = lat
         self.tz_str = tz_str
-        self._geonames_username = geonames_username
         self.zodiac_type = zodiac_type
         self.online = online
         self.json_dir = Path.home()
+        self.geonames_username = geonames_username
+
+        # This message is set to encourage the user to set a custom geonames username
+        if geonames_username is None and online:
+            logger.info(
+                "\n"
+                "********" + \
+                "\n" + \
+                "NO GEONAMES USERNAME SET!" + \
+                "\n" + \
+                "Using the default geonames username is not recommended, please set a custom one!" + \
+                "\n" + \
+                "You can get one for free here:" + \
+                "\n" + \
+                "https://www.geonames.org/login" + \
+                "\n" + \
+                "Keep in mind that the default username is limited to 2000 requests per hour and is shared with everyone else using this library." + \
+                "\n" + \
+                "********"
+            )
+
+            self.geonames_username = DEFAULT_GEONAMES_USERNAME
 
         if not self.city:
             self.city = "London"
@@ -197,7 +218,7 @@ class AstrologicalSubject:
         geonames = FetchGeonames(
             self.city,
             self.nation,
-            username=self._geonames_username,
+            username=self.geonames_username,
         )
         self.city_data: dict[str, str] = geonames.get_serialized_data()
 
@@ -243,7 +264,50 @@ class AstrologicalSubject:
         self.julian_day = float(swe.julday(self.utc.year, self.utc.month, self.utc.day, self.utc_time))
 
     def _houses(self) -> None:
-        """Calculate positions and store them in dictionaries"""
+        """
+        Calculate positions and store them in dictionaries
+
+        https://www.astro.com/faq/fq_fh_owhouse_e.htm
+        https://github.com/jwmatthys/pd-swisseph/blob/master/swehouse.c#L685
+        hsys = letter code for house system;
+            A  equal
+            E  equal
+            B  Alcabitius
+            C  Campanus
+            D  equal (MC)
+            F  Carter "Poli-Equatorial"
+            G  36 Gauquelin sectors
+            H  horizon / azimut
+            I  Sunshine solution Treindl
+            i  Sunshine solution Makransky
+            K  Koch
+            L  Pullen SD "sinusoidal delta", ex Neo-Porphyry
+            M  Morinus
+            N  equal/1=Aries
+            O  Porphyry
+            P  Placidus
+            Q  Pullen SR "sinusoidal ratio"
+            R  Regiomontanus
+            S  Sripati
+            T  Polich/Page ("topocentric")
+            U  Krusinski-Pisa-Goelzer
+            V  equal Vehlow
+            W  equal, whole sign
+            X  axial rotation system/ Meridian houses
+            Y  APC houses
+        """
+
+        if self.zodiac_type == "Sidereal":
+            self.houses_degree_ut = swe.houses_ex(
+                tjdut=self.julian_day, lat=self.lat, lon=self.lng, hsys=str.encode('P'), flags=swe.FLG_SIDEREAL
+            )[0]
+        elif self.zodiac_type == "Tropic":
+            self.houses_degree_ut = swe.houses(
+                tjdut=self.julian_day, lat=self.lat, lon=self.lng, hsys=str.encode('P')
+            )[0]
+        else:
+            raise KerykeionException("Zodiac type not recognized! Please use 'Tropic' or 'Sidereal'")
+
         point_type: Literal["Planet", "House"] = "House"
         # creates the list of the house in 360°
         self.houses_degree_ut = swe.houses(self.julian_day, self.lat, self.lng)[0]

{kerykeion-4.0.7 → kerykeion-4.1.1}/kerykeion/charts/kerykeion_chart_svg.py

@@ -7,7 +7,7 @@
 import pytz
 
 from datetime import datetime
-from kerykeion.settings.kerykeion_settings import get_settings_dict
+from kerykeion.settings.kerykeion_settings import get_settings
 from kerykeion.aspects.synastry_aspects import SynastryAspects
 from kerykeion.aspects.natal_aspects import NatalAspects
 from kerykeion.astrological_subject import AstrologicalSubject
@@ -127,7 +127,7 @@ class KerykeionChartSVG:
 
         if self.chart_type == "Natal" or self.chart_type == "ExternalNatal":
             natal_aspects_instance = NatalAspects(self.user, new_settings_file=self.new_settings_file)
-            self.aspects_list = natal_aspects_instance.get_relevant_aspects()
+            self.aspects_list = natal_aspects_instance.relevant_aspects
 
         # TODO: If not second should exit
         if self.chart_type == "Transit" or self.chart_type == "Synastry":
@@ -279,7 +279,7 @@ class KerykeionChartSVG:
         """
         Parse the settings file.
         """
-        settings = get_settings_dict(settings_file)
+        settings = get_settings(settings_file)
 
         language = settings["general_settings"]["language"]
         self.language_settings = settings["language_settings"].get(language, "EN")
@@ -1080,7 +1080,7 @@ class KerykeionChartSVG:
     def _makeAspectsTransit(self, r, ar):
         out = ""
 
-        self.aspects_list = SynastryAspects(self.user, self.t_user, new_settings_file=self.new_settings_file).get_relevant_aspects()
+        self.aspects_list = SynastryAspects(self.user, self.t_user, new_settings_file=self.new_settings_file).relevant_aspects
 
         for element in self.aspects_list:
             out += self._drawAspect(

{kerykeion-4.0.7 → kerykeion-4.1.1}/kerykeion/relationship_score.py

@@ -59,7 +59,7 @@ class RelationshipScore:
         self.relevant_default_aspects = []
         self.__all_synastry_aspects = SynastryAspects(
             first_subject, second_subject, new_settings_file=new_settings_file
-        ).get_all_aspects()
+        ).all_aspects
 
         # Calculates all at initialization
         self._get_all()

{kerykeion-4.0.7 → kerykeion-4.1.1}/kerykeion/settings/__init__.py

@@ -1 +1 @@
-from .kerykeion_settings import KerykeionSettingsModel, get_settings_dict
+from .kerykeion_settings import KerykeionSettingsModel, get_settings

{kerykeion-4.0.7 → kerykeion-4.1.1}/kerykeion/settings/kerykeion_settings.py

@@ -17,7 +17,7 @@ basicConfig(format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level
 
 
 
-def get_settings_dict(new_settings_file: Union[Path, None] = None) -> KerykeionSettingsModel:
+def get_settings(new_settings_file: Union[Path, None] = 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:
@@ -71,4 +71,4 @@ def merge_settings(settings: KerykeionSettingsModel, new_settings: Dict) -> Kery
 
 
 if __name__ == "__main__":
-    print(get_settings_dict())
+    print(get_settings())

{kerykeion-4.0.7 → kerykeion-4.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kerykeion"
-version = "4.0.7"
+version = "4.1.1"
 authors = ["Giacomo Battaglia <battaglia.giacomo@yahoo.it>"]
 description = "A python library for astrology."
 license = "AGPL-3.0"
@@ -85,7 +85,7 @@ line-length = 120
 [tool.poe.tasks]
 test = "pytest"
 test-no-capture = "poetry run pytest --show-capture no  "
-lint = "mypy"
+analize = "mypy"
 docs = "pdoc kerykeion -o ./docs"
 format = "black --line-length 120"
 "format:all" = "black kerykeion tests --line-length 120"