kerykeion 4.15.0__tar.gz → 4.18.0__tar.gz

{kerykeion-4.15.0 → kerykeion-4.18.0}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: kerykeion
-Version: 4.15.0
+Version: 4.18.0
 Summary: A python library for astrology.
 Home-page: https://www.kerykeion.net/
 License: AGPL-3.0
 Keywords: astrology,ephemeris,astrology library,birtchart,svg,zodiac,zodiac-sing,astronomical-algorithms,synastry,astrology-calculator
 Author: Giacomo Battaglia
-Author-email: battaglia.giacomo@yahoo.it
+Author-email: kerykeion.astrology@gmail.com
 Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -189,9 +189,12 @@ synastry_chart.makeSVG()
 
 ### Change Language
 
-To change the language of the chart you should create a new kr.config.js file and pass it to the BirthChartSVG class. So far the available languages are English, Portuguese, Italian, Spanish, French and Chinese.
+You can change the language of the SVG by passing the `chart_language` parameter to the KerykeionChartSVG class:
 
-Some examples [here](https://www.kerykeion.net/docs/examples/change-language).
+```python
+first = AstrologicalSubject("John Lennon", 1940, 10, 9, 18, 30, "Liverpool", "GB", chart_language="ES")
+```
+More details [here](https://www.kerykeion.net/docs/examples/chart-language).
 
 ## Report
 
@@ -318,6 +321,29 @@ More examples [here](https://www.kerykeion.net/docs/examples/perspective-type/).
 
 Full list of supported perspective types [here](https://www.kerykeion.net/pydocs/kerykeion/kr_types/kr_literals.html#PerspectiveType).
 
+## Themes
+
+You can now personalize your astrological charts with different themes! Four themes are available:
+
+- **Classic** (default)
+- **Dark**
+- **Dark High Contrast**
+- **Light**
+
+Each theme offers a distinct visual style, allowing you to choose the one that best suits your preferences or presentation needs. If you prefer more control over the appearance, you can opt not to set any theme, making it easier to customize the chart by overriding the default CSS variables. For more detailed instructions on how to apply themes, check the [documentation](https://www.kerykeion.net/docs/examples/theming)
+
+Here's an example of how to set the theme:
+
+```python
+from kerykeion import AstrologicalSubject, KerykeionChartSVG
+
+dark_theme_subject = AstrologicalSubject("John Lennon - Dark Theme", 1940, 10, 9, 18, 30, "Liverpool", "GB")
+dark_theme_natal_chart = KerykeionChartSVG(dark_high_contrast_theme_subject, theme="dark_high_contrast")
+dark_theme_natal_chart.makeSVG()
+```
+
+![John Lennon](https://www.kerykeion.net/assets/img/showcase/John%20Lennon%20-%20Dark%20-%20Natal%20Chart.svg)
+
 ## Alternative Initialization
 
 You can initialize the AstrologicalSubject from a **UTC** ISO 8601 string:
@@ -351,16 +377,20 @@ Sooner or later I'll try to write an extensive documentation.
 
 You can clone this repository or download a zip file using the right side buttons.
 
-## Contributing
+## Integrate Kerykeion Functionalities in Your Project
 
-Feel free to contribute to the code!
+If you are interested in integrating Kerykeion's astrological functionalities into your project, I would be happy to collaborate with you. Whether you need custom features, support, or consultation, feel free to reach out to me at my [email](mailto:kerykeion.astrology@gmail.com?subject=Integration%20Request) address.
 
 ## License
 
 This project is licensed under the AGPL-3.0 License.
 To understand how this impacts your use of the software, please see the [LICENSE](LICENSE) file for details.
-If you have questions, you can reach out to me at my [email](mailto:battaglia.giacomo@yahoo.it?subject=Kerykeion) address.
+If you have questions, you can reach out to me at my [email](mailto:kerykeion.astrology@gmail.com?subject=Kerykeion) address.
 As a rule of thumb, if you are using this library in a project, you should open source the code of the project with a compatible license.
 
 You can implement the logic of kerykeion in your project and also keep it closed source by using a third party API, like the [AstrologerAPI](https://rapidapi.com/gbattaglia/api/astrologer/). The AstrologerAPI is AGPL-3.0 compliant. Subscribing to the API is also, currently, the best way to support the project.
 
+## Contributing
+
+Feel free to contribute to the code!
+

{kerykeion-4.15.0 → kerykeion-4.18.0}/README.md

@@ -152,9 +152,12 @@ synastry_chart.makeSVG()
 
 ### Change Language
 
-To change the language of the chart you should create a new kr.config.js file and pass it to the BirthChartSVG class. So far the available languages are English, Portuguese, Italian, Spanish, French and Chinese.
+You can change the language of the SVG by passing the `chart_language` parameter to the KerykeionChartSVG class:
 
-Some examples [here](https://www.kerykeion.net/docs/examples/change-language).
+```python
+first = AstrologicalSubject("John Lennon", 1940, 10, 9, 18, 30, "Liverpool", "GB", chart_language="ES")
+```
+More details [here](https://www.kerykeion.net/docs/examples/chart-language).
 
 ## Report
 
@@ -281,6 +284,29 @@ More examples [here](https://www.kerykeion.net/docs/examples/perspective-type/).
 
 Full list of supported perspective types [here](https://www.kerykeion.net/pydocs/kerykeion/kr_types/kr_literals.html#PerspectiveType).
 
+## Themes
+
+You can now personalize your astrological charts with different themes! Four themes are available:
+
+- **Classic** (default)
+- **Dark**
+- **Dark High Contrast**
+- **Light**
+
+Each theme offers a distinct visual style, allowing you to choose the one that best suits your preferences or presentation needs. If you prefer more control over the appearance, you can opt not to set any theme, making it easier to customize the chart by overriding the default CSS variables. For more detailed instructions on how to apply themes, check the [documentation](https://www.kerykeion.net/docs/examples/theming)
+
+Here's an example of how to set the theme:
+
+```python
+from kerykeion import AstrologicalSubject, KerykeionChartSVG
+
+dark_theme_subject = AstrologicalSubject("John Lennon - Dark Theme", 1940, 10, 9, 18, 30, "Liverpool", "GB")
+dark_theme_natal_chart = KerykeionChartSVG(dark_high_contrast_theme_subject, theme="dark_high_contrast")
+dark_theme_natal_chart.makeSVG()
+```
+
+![John Lennon](https://www.kerykeion.net/assets/img/showcase/John%20Lennon%20-%20Dark%20-%20Natal%20Chart.svg)
+
 ## Alternative Initialization
 
 You can initialize the AstrologicalSubject from a **UTC** ISO 8601 string:
@@ -314,15 +340,19 @@ Sooner or later I'll try to write an extensive documentation.
 
 You can clone this repository or download a zip file using the right side buttons.
 
-## Contributing
+## Integrate Kerykeion Functionalities in Your Project
 
-Feel free to contribute to the code!
+If you are interested in integrating Kerykeion's astrological functionalities into your project, I would be happy to collaborate with you. Whether you need custom features, support, or consultation, feel free to reach out to me at my [email](mailto:kerykeion.astrology@gmail.com?subject=Integration%20Request) address.
 
 ## License
 
 This project is licensed under the AGPL-3.0 License.
 To understand how this impacts your use of the software, please see the [LICENSE](LICENSE) file for details.
-If you have questions, you can reach out to me at my [email](mailto:battaglia.giacomo@yahoo.it?subject=Kerykeion) address.
+If you have questions, you can reach out to me at my [email](mailto:kerykeion.astrology@gmail.com?subject=Kerykeion) address.
 As a rule of thumb, if you are using this library in a project, you should open source the code of the project with a compatible license.
 
 You can implement the logic of kerykeion in your project and also keep it closed source by using a third party API, like the [AstrologerAPI](https://rapidapi.com/gbattaglia/api/astrologer/). The AstrologerAPI is AGPL-3.0 compliant. Subscribing to the API is also, currently, the best way to support the project.
+
+## Contributing
+
+Feel free to contribute to the code!

{kerykeion-4.15.0 → kerykeion-4.18.0}/kerykeion/__init__.py

@@ -9,7 +9,8 @@ This is part of Kerykeion (C) 2024 Giacomo Battaglia
 from .astrological_subject import AstrologicalSubject
 from .charts.kerykeion_chart_svg import KerykeionChartSVG
 from .kr_types import *
-from .relationship_score import RelationshipScore
+from .relationship_score.relationship_score import RelationshipScore
+from .relationship_score.relationship_score_factory import RelationshipScoreFactory
 from .aspects import SynastryAspects, NatalAspects
 from .report import Report
 from .settings import KerykeionSettingsModel, get_settings

kerykeion-4.18.0/kerykeion/aspects/aspects_utils.py

@@ -0,0 +1,91 @@
+# -*- 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
+from kerykeion.kr_types.kr_models import AstrologicalSubjectModel
+from kerykeion.kr_types.settings_models import KerykeionSettingsCelestialPointModel, KerykeionSettingsAspectModel
+
+
+def get_aspect_from_two_points(
+    aspects_settings: Union[list[KerykeionSettingsAspectModel], list[dict]],
+    point_one: Union[float, int],
+    point_two: Union[float, int],
+):
+    """
+    Utility function to calculate the aspects between two points.
+
+    Args:
+        aspects_settings (dict): Dictionary containing aspect settings.
+        point_one (Union[float, int]): First point.
+        point_two (Union[float, int]): Second point.
+
+    Returns:
+        dict: Dictionary containing the aspect details.
+    """
+    distance = abs(difdeg2n(point_one, point_two))
+    diff = abs(point_one - point_two)
+
+    for aid, aspect in enumerate(aspects_settings):
+        aspect_degree = aspect["degree"] # type: ignore
+        aspect_orb = aspect["orb"] # type: ignore
+
+        if (aspect_degree - aspect_orb) <= int(distance) <= (aspect_degree + aspect_orb):
+            name = aspect["name"] # type: ignore
+            aspect_degrees = aspect_degree
+            verdict = True
+            break
+    else:
+        verdict = False
+        name = None
+        aspect_degrees = 0
+        aid = None # type: ignore
+
+    return {
+        "verdict": verdict,
+        "name": name,
+        "orbit": distance - aspect_degrees,
+        "distance": distance - aspect_degrees,
+        "aspect_degrees": aspect_degrees,
+        "aid": aid,
+        "diff": diff,
+    }
+
+
+def planet_id_decoder(planets_settings: list[KerykeionSettingsCelestialPointModel], name: str) -> int:
+    """
+    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
+
+    raise ValueError(f"Planet {name} not found in the settings")
+
+
+def get_active_points_list(
+    subject: Union[AstrologicalSubject, AstrologicalSubjectModel], 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-4.15.0 → kerykeion-4.18.0}/kerykeion/aspects/natal_aspects.py

@@ -11,7 +11,8 @@ 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
-from kerykeion.kr_types.kr_models import AstrologicalSubjectModel
+from kerykeion.kr_types.kr_models import AstrologicalSubjectModel, AspectModel
+from kerykeion.kr_types.settings_models import KerykeionSettingsModel
 
 
 AXES_LIST = [
@@ -29,14 +30,14 @@ class NatalAspects:
     """
 
     user: Union[AstrologicalSubject, AstrologicalSubjectModel]
-    new_settings_file: Union[Path, None] = None
+    new_settings_file: Union[Path, KerykeionSettingsModel, dict, None] = None
 
     def __post_init__(self):
         self.settings = get_settings(self.new_settings_file)
 
-        self.celestial_points = self.settings["celestial_points"]
-        self.aspects_settings = self.settings["aspects"]
-        self.axes_orbit_settings = self.settings["general_settings"]["axes_orbit"]
+        self.celestial_points = self.settings.celestial_points
+        self.aspects_settings = self.settings.aspects
+        self.axes_orbit_settings = self.settings.general_settings.axes_orbit
 
     @cached_property
     def all_aspects(self):
@@ -54,7 +55,8 @@ class NatalAspects:
             # Generates the aspects list without repetitions
             for second in range(first + 1, len(active_points_list)):
                 aspect = get_aspect_from_two_points(
-                    self.aspects_settings, active_points_list[first]["abs_pos"], active_points_list[second]["abs_pos"]
+                    self.aspects_settings, active_points_list[first]["abs_pos"], 
+                    active_points_list[second]["abs_pos"]
                 )
 
                 verdict = aspect["verdict"]
@@ -63,27 +65,23 @@ class NatalAspects:
                 aspect_degrees = aspect["aspect_degrees"]
                 aid = aspect["aid"]
                 diff = aspect["diff"]
-                
 
                 if verdict == True:
-                    d_asp = {
-                        "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,
-                        "aid": aid,
-                        "diff": diff,
-                        "p1": planet_id_decoder(self.celestial_points, active_points_list[first]["name"]),
-                        "p2": planet_id_decoder(
-                            self.celestial_points,
-                            active_points_list[second]["name"],
-                        ),
-                    }
-
-                    self.all_aspects_list.append(d_asp)
+                    aspect_model = AspectModel(
+                        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,
+                        aid=aid,
+                        diff=diff,
+                        p1=planet_id_decoder(self.celestial_points, active_points_list[first]["name"]),
+                        p2=planet_id_decoder(self.celestial_points, active_points_list[second]["name"]),
+                        is_major=self.aspects_settings[aid]["is_major"],
+                    )
+                    self.all_aspects_list.append(aspect_model)
 
         return self.all_aspects_list
 
@@ -94,6 +92,7 @@ class NatalAspects:
         the most important are hardcoded.
         Set the list with set_points and creating a list with the names
         or the numbers of the houses.
+        The relevant aspects are the ones that are set as active ("is_active") in the settings.
         """
 
         logging.debug("Relevant aspects not already calculated, calculating now...")
@@ -128,6 +127,7 @@ 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")

{kerykeion-4.15.0 → kerykeion-4.18.0}/kerykeion/aspects/synastry_aspects.py

@@ -11,7 +11,8 @@ from functools import cached_property
 from kerykeion.aspects.natal_aspects import NatalAspects
 from kerykeion.settings.kerykeion_settings import get_settings
 from kerykeion.aspects.aspects_utils import planet_id_decoder, get_aspect_from_two_points, get_active_points_list
-from kerykeion.kr_types.kr_models import AstrologicalSubjectModel
+from kerykeion.kr_types.kr_models import AstrologicalSubjectModel, AspectModel
+from kerykeion.kr_types.settings_models import KerykeionSettingsModel
 from typing import Union
 
 
@@ -24,7 +25,7 @@ class SynastryAspects(NatalAspects):
         self,
         kr_object_one: Union[AstrologicalSubject, AstrologicalSubjectModel],
         kr_object_two: Union[AstrologicalSubject, AstrologicalSubjectModel],
-        new_settings_file: Union[Path, None] = None,
+        new_settings_file: Union[Path, KerykeionSettingsModel, dict, None] = None,
     ):
         # Subjects
         self.first_user = kr_object_one
@@ -34,9 +35,9 @@ class SynastryAspects(NatalAspects):
         self.new_settings_file = new_settings_file
         self.settings = get_settings(self.new_settings_file)
 
-        self.celestial_points = self.settings["celestial_points"]
-        self.aspects_settings = self.settings["aspects"]
-        self.axes_orbit_settings = self.settings["general_settings"]["axes_orbit"]
+        self.celestial_points = self.settings.celestial_points
+        self.aspects_settings = self.settings.aspects
+        self.axes_orbit_settings = self.settings.general_settings.axes_orbit
 
         # Private variables of the aspects
         self._all_aspects: Union[list, None] = None
@@ -75,34 +76,29 @@ class SynastryAspects(NatalAspects):
                 aid = aspect["aid"]
                 diff = aspect["diff"]
 
-
                 if verdict == True:
-                    d_asp = {
-                        "p1_name": first_active_points_list[first]["name"],
-                        "p1_abs_pos": first_active_points_list[first]["abs_pos"],
-                        "p2_name": second_active_points_list[second]["name"],
-                        "p2_abs_pos": second_active_points_list[second]["abs_pos"],
-                        "aspect": name,
-                        "orbit": orbit,
-                        "aspect_degrees": aspect_degrees,
-                        "aid": aid,
-                        "diff": diff,
-                        "p1": planet_id_decoder(
-                            self.settings.celestial_points, first_active_points_list[first]["name"]
-                        ),
-                        "p2": planet_id_decoder(
-                            self.settings.celestial_points,
-                            second_active_points_list[second]["name"],
-                        ),
-                    }
-
-                    self.all_aspects_list.append(d_asp)
+                    aspect_model = AspectModel(
+                        p1_name=first_active_points_list[first]["name"],
+                        p1_abs_pos=first_active_points_list[first]["abs_pos"],
+                        p2_name=second_active_points_list[second]["name"],
+                        p2_abs_pos=second_active_points_list[second]["abs_pos"],
+                        aspect=name,
+                        orbit=orbit,
+                        aspect_degrees=aspect_degrees,
+                        aid=aid,
+                        diff=diff,
+                        p1=planet_id_decoder(self.celestial_points, first_active_points_list[first]["name"]),
+                        p2=planet_id_decoder(self.celestial_points, second_active_points_list[second]["name"]),
+                        is_major=self.aspects_settings[aid]["is_major"],
+                    )
+                    self.all_aspects_list.append(aspect_model)
 
         return self.all_aspects_list
 
 
 if __name__ == "__main__":
     from kerykeion.utilities import setup_logging
+
     setup_logging(level="debug")
 
     john = AstrologicalSubject("John", 1940, 10, 9, 18, 30, "Liverpool")

{kerykeion-4.15.0 → kerykeion-4.18.0}/kerykeion/astrological_subject.py

@@ -812,3 +812,7 @@ if __name__ == "__main__":
     # Test Mean Lilith
     johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", disable_chiron_and_lilith=True)
     print(johnny.mean_lilith)
+
+    # Offline mode
+    johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", online=False, tz_str="America/New_York", lng=-87.1111, lat=37.7711)
+    print(johnny.json(dump=True, indent=2))