kerykeion 4.9.1__py3-none-any.whl → 4.10.1__py3-none-any.whl

kerykeion/__init__.py

@@ -13,7 +13,7 @@
     </a>
     <a href="https://pypi.org/project/kerykeion" target="_blank">
         <img src="https://visitor-badge.laobi.icu/badge?page_id=g-battaglia.kerykeion" alt="visitors"/>
-    </a>    
+    </a>
     <a href="https://pypi.org/project/kerykeion" target="_blank">
         <img src="https://img.shields.io/pypi/v/kerykeion?label=pypi%20package" alt="Package version">
     </a>
@@ -102,7 +102,7 @@ kanye = AstrologicalSubject(
 The difference is that you have to pass the longitude, latitude and the timezone string, instead of the city and nation.
 If you omit the nation, it will be set to "GB" by default, but the value is not used for calculations. It's better to set it to the correct value though.
 
-## Generate a SVG Chart:
+## Generate a SVG Chart
 
 ```python
 from kerykeion import AstrologicalSubject, KerykeionChartSVG
@@ -141,7 +141,7 @@ report.print_report()
 
 Returns:
 
-```
+```bash
 +- Kerykeion report for Kanye -+
 +----------+------+-------------+-----------+----------+
 | Date     | Time | Location    | Longitude | Latitude |
@@ -187,7 +187,7 @@ Returns:
 And if you want to export it to a file:
 
 ```bash
-$ python3 your_script_name.py > file.txt
+python3 your_script_name.py > file.txt
 ```
 
 ## Other exeples of possibles usecase
@@ -209,6 +209,14 @@ print(aspect_list[0])
 
 ```
 
+## Ayanamsa (Sidereal Modes)
+
+You can set the zodiac type and the sidereal mode in the AstrologicalSubject class:
+
+```python
+johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", zodiac_type="Sidereal", sidereal_mode="LAHIRI")
+```
+
 ## Documentation
 
 Most of the functions and the classes are self documented by the types and have docstrings.
@@ -231,8 +239,7 @@ To understand how this impacts your use of the software, please see the [LICENSE
 If you have questions, you can reach out to me at my [email](mailto:battaglia.giacomo@yahoo.it?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 kerkeion 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.
-
+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.
 """
 
 # Local

kerykeion/astrological_subject.py

@@ -15,7 +15,8 @@ from kerykeion.kr_types import (
     AstrologicalSubjectModel,
     LunarPhaseModel,
     KerykeionPointModel,
-    PointType
+    PointType,
+    SiderealMode
 )
 from kerykeion.utilities import (
     get_number_from_name, 
@@ -25,9 +26,10 @@ from kerykeion.utilities import (
     get_moon_phase_name_from_phase_int,
 )
 from pathlib import Path
-from typing import Union
+from typing import Union, get_args
 
 DEFAULT_GEONAMES_USERNAME = "century.boy"
+DEFAULT_SIDEREAL_MODE = "FAGAN_BRADLEY"
 
 
 class AstrologicalSubject:
@@ -59,6 +61,10 @@ class AstrologicalSubject:
         _ Defaults to None.
     - disable_chiron (bool, optional): Disables the calculation of Chiron. Defaults to False.
         Chiron calculation can create some issues with the Swiss Ephemeris when the date is too far in the past.
+    - sidereal_mode (SiderealMode, optional): Also known as Ayanamsa. 
+        The mode to use for the sidereal zodiac, according to the Swiss Ephemeris.
+        Defaults to "FAGAN_BRADLEY".
+        Available modes are visible in the SiderealMode Literal.
     """
 
     # Defined by the user
@@ -77,6 +83,7 @@ class AstrologicalSubject:
     geonames_username: str
     online: bool
     zodiac_type: ZodiacType
+    sidereal_mode: SiderealMode
 
     # Generated internally
     city_data: dict[str, str]
@@ -140,16 +147,16 @@ class AstrologicalSubject:
         zodiac_type: ZodiacType = "Tropic",
         online: bool = True,
         utc_datetime: Union[datetime, None] = None,
-        disable_chiron: bool = False
+        disable_chiron: bool = False,
+        sidereal_mode: Union[SiderealMode, None] = None
     ) -> None:
         logging.debug("Starting Kerykeion")
 
         # We set the swisseph path to the current directory
-        swe.set_ephe_path(
-            str(
-                Path(__file__).parent.absolute() / "sweph"
-            )
-        )
+        swe.set_ephe_path(str(Path(__file__).parent.absolute() / "sweph"))
+        
+        # Flags for the Swiss Ephemeris
+        self._iflag = swe.FLG_SWIEPH + swe.FLG_SPEED
 
         self.name = name
         self.year = year
@@ -168,6 +175,29 @@ class AstrologicalSubject:
         self.geonames_username = geonames_username
         self.utc_datetime = utc_datetime
         self.disable_chiron = disable_chiron
+        self.sidereal_mode = sidereal_mode
+
+        # Zodiac Type and Sidereal mode checks and setup --->
+        if zodiac_type and not zodiac_type in get_args(ZodiacType):
+            raise KerykeionException(f"\n* ERROR: '{zodiac_type}' is NOT a valid zodiac type! Available types are: *" + "\n" + str(get_args(ZodiacType)))
+
+        if self.sidereal_mode and self.zodiac_type == "Tropic":
+            raise KerykeionException("You can't set a sidereal mode with a Tropic zodiac type!")
+        
+        if self.zodiac_type == "Sidereal" and not self.sidereal_mode:
+            self.sidereal_mode = DEFAULT_SIDEREAL_MODE
+            logging.info("No sidereal mode set, using default FAGAN_BRADLEY")
+
+        if self.zodiac_type == "Sidereal":
+            # Check if the sidereal mode is valid
+            if not self.sidereal_mode in get_args(SiderealMode):
+                raise KerykeionException(f"\n* ERROR: '{self.sidereal_mode}' is NOT a valid sidereal mode! Available modes are: *" + "\n" + str(get_args(SiderealMode)))
+
+            self._iflag += swe.FLG_SIDEREAL
+            mode = "SIDM_" + self.sidereal_mode
+            swe.set_sid_mode(getattr(swe, mode))
+            logging.debug(f"Using sidereal mode: {mode}")
+        # <--- Zodiac Type and Sidereal mode checks and setup
 
         # This message is set to encourage the user to set a custom geonames username
         if geonames_username is None and online:
@@ -207,9 +237,7 @@ class AstrologicalSubject:
             logging.info("No longitude specified, using London as default")
 
         if (not self.online) and (not tz_str):
-            raise KerykeionException(
-                "You need to set the coordinates and timezone if you want to use the offline mode!"
-            )
+            raise KerykeionException("You need to set the coordinates and timezone if you want to use the offline mode!")
 
         self._check_if_poles()
 
@@ -328,12 +356,9 @@ class AstrologicalSubject:
             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: PointType = "House"
-        # creates the list of the house in 360°
-        self.houses_degree_ut = swe.houses(self.julian_day, self.lat, self.lng)[0]
+
         # stores the house in singular dictionaries.
         self.first_house = calculate_position(self.houses_degree_ut[0], "First_House", point_type=point_type)
         self.second_house = calculate_position(self.houses_degree_ut[1], "Second_House", point_type=point_type)
@@ -365,12 +390,6 @@ class AstrologicalSubject:
 
     def _planets_degrees_lister(self):
         """Sidereal or tropic mode."""
-        self._iflag = swe.FLG_SWIEPH + swe.FLG_SPEED
-
-        if self.zodiac_type == "Sidereal":
-            self._iflag += swe.FLG_SIDEREAL
-            mode = "SIDM_FAGAN_BRADLEY"
-            swe.set_sid_mode(getattr(swe, mode))
 
         # Calculates the position of the planets and stores it in a list.
         sun_deg = swe.calc(self.julian_day, 0, self._iflag)[0][0]
@@ -569,7 +588,7 @@ class AstrologicalSubject:
             self.lat = -66.0
             logging.info("Polar circle override for houses, using -66 degrees")
 
-    def json(self, dump=False, destination_folder: Union[str, None] = None) -> str:
+    def json(self, dump=False, destination_folder: Union[str, None] = None, indent: Union[int, None] = None) -> str:
         """
         Dumps the Kerykeion object to a json string foramt,
         if dump=True also dumps to file located in destination
@@ -577,7 +596,7 @@ class AstrologicalSubject:
         """
 
         KrData = AstrologicalSubjectModel(**self.__dict__)
-        json_string = KrData.model_dump_json(exclude_none=True)
+        json_string = KrData.model_dump_json(exclude_none=True, indent=indent)
 
         if dump:
             if destination_folder:
@@ -620,3 +639,7 @@ if __name__ == "__main__":
 
     print('\n')
     print(johnny.chiron)
+
+    # With Sidereal Zodiac
+    johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", zodiac_type="Sidereal", sidereal_mode="LAHIRI")
+    print(johnny.json(dump=True, indent=2))

kerykeion/charts/kerykeion_chart_svg.py

@@ -45,9 +45,9 @@ class KerykeionChartSVG:
         - first_obj: First kerykeion object
         - chart_type: Natal, ExternalNatal, Transit, Synastry (Default: Type="Natal").
         - second_obj: Second kerykeion object (Not required if type is Natal)
-        - new_output_directory: Set the output directory (default: output_directory)
-        - lang: language settings (default: "EN")
-        - new_settings_file: Set the settings file (default: kr.config.json)
+        - new_output_directory: Set the output directory (default: home directory).
+        - new_settings_file: Set the settings file (default: kr.config.json).
+            In the settings file you can set the language, colors, planets, aspects, etc.
     """
     
     # Constants
@@ -218,7 +218,6 @@ class KerykeionChartSVG:
                 self.t_houses_sign_graph.append(h["sign_num"])
 
         # screen size
-        
         self.height = self._DEFAULT_HEIGHT
         if self.chart_type == "Synastry" or self.chart_type == "Transit":
             self.width = self._DEFAULT_FULL_WIDTH
@@ -1159,7 +1158,6 @@ class KerykeionChartSVG:
         svgHeight = "100%"
         svgWidth = "100%"
         rotate = "0"
-        translate = "0"
         
         # To increase the size of the chart, change the viewbox
         if self.chart_type == "Natal" or self.chart_type == "ExternalNatal":
@@ -1218,6 +1216,7 @@ class KerykeionChartSVG:
         td["svgHeight"] = str(svgHeight)
         td["viewbox"] = viewbox
 
+        # Chart Title
         if self.chart_type == "Synastry":
             td["stringTitle"] = f"{self.user.name} {self.language_settings['and_word']} {self.t_user.name}"
 
@@ -1227,17 +1226,24 @@ class KerykeionChartSVG:
         else:
             td["stringTitle"] = self.user.name
 
-        # Tipo di carta
+        # Chart Name
         if self.chart_type == "Synastry" or self.chart_type == "Transit":
             td["stringName"] = f"{self.user.name}:"
         else:
             td["stringName"] = f'{self.language_settings["info"]}:'
 
-        # bottom left
-        td["bottomLeft1"] = ""
-        td["bottomLeft2"] = ""
-        td["bottomLeft3"] = f'{self.language_settings.get("lunar_phase", "Lunar Phase")}: {self.language_settings.get("day", "Day")} {self.user.lunar_phase.get("moon_phase", "")}'
-        td["bottomLeft4"] = ""
+        # Bottom Left Corner
+        if self.chart_type == "Natal" or self.chart_type == "ExternalNatal" or self.chart_type == "Synastry":
+            td["bottomLeft1"] = f"{self.user.zodiac_type if self.user.zodiac_type == 'Tropic' else self.user.zodiac_type + ' ' + self.user.sidereal_mode}"
+            td["bottomLeft2"] = f'{self.language_settings.get("lunar_phase", "Lunar Phase")}: {self.user.lunar_phase.moon_phase_name}'
+            td["bottomLeft3"] = f'{self.language_settings.get("lunar_phase", "Lunar Phase")}: {self.language_settings.get("day", "Day")} {self.user.lunar_phase.get("moon_phase", "")}'
+            td["bottomLeft4"] = ""
+
+        else:
+            td["bottomLeft1"] = f"{self.user.zodiac_type if self.user.zodiac_type == 'Tropic' else self.user.zodiac_type + ' ' + self.user.sidereal_mode}"
+            td["bottomLeft2"] = f'{self.language_settings.get("lunar_phase", "Lunar Phase")}: {self.t_user.lunar_phase.moon_phase_name}'
+            td["bottomLeft3"] = f'{self.language_settings.get("lunar_phase", "Lunar Phase")}: {self.language_settings.get("day", "Day")} {self.t_user.lunar_phase.get("moon_phase", "")}'
+            td["bottomLeft4"] = ""
 
         # lunar phase
         deg = self.user.lunar_phase["degrees_between_s_m"]
@@ -1348,7 +1354,6 @@ class KerykeionChartSVG:
         # config
         td["cfgZoom"] = str(self.zoom)
         td["cfgRotate"] = rotate
-        td["cfgTranslate"] = translate
 
         # ---
         # Drawing Functions
@@ -1401,7 +1406,7 @@ class KerykeionChartSVG:
         if not (self.template):
             self.template = self.makeTemplate(minify)
 
-        self.chartname = self.output_directory / f"{self.user.name}{self.chart_type}Chart.svg"
+        self.chartname = self.output_directory / f"{self.user.name} - {self.chart_type} Chart.svg"
 
         with open(self.chartname, "w", encoding="utf-8", errors="ignore") as output_file:
             output_file.write(self.template)
@@ -1426,9 +1431,28 @@ if __name__ == "__main__":
 
     # Synastry Chart
     synastry_chart = KerykeionChartSVG(first, "Synastry", second)
-    synastry_chart.makeSVG(minify=True)
+    synastry_chart.makeSVG()
 
     # Transits Chart
     transits_chart = KerykeionChartSVG(first, "Transit", second)
-    transits_chart.makeSVG(minify=True)
-
+    transits_chart.makeSVG()
+    
+    # Sidereal Birth Chart (Lahiri)
+    sidereal_subject = AstrologicalSubject("John Lennon Lahiri", 1940, 10, 9, 10, 30, "Liverpool", "GB", zodiac_type="Sidereal", sidereal_mode="LAHIRI")
+    sidereal_chart = KerykeionChartSVG(sidereal_subject)
+    sidereal_chart.makeSVG()
+
+    # Sidereal Birth Chart (Fagan-Bradley)
+    sidereal_subject = AstrologicalSubject("John Lennon Fagan-Bradley", 1940, 10, 9, 10, 30, "Liverpool", "GB", zodiac_type="Sidereal", sidereal_mode="FAGAN_BRADLEY")
+    sidereal_chart = KerykeionChartSVG(sidereal_subject)
+    sidereal_chart.makeSVG()
+
+    # Sidereal Birth Chart (DeLuce)
+    sidereal_subject = AstrologicalSubject("John Lennon DeLuce", 1940, 10, 9, 10, 30, "Liverpool", "GB", zodiac_type="Sidereal", sidereal_mode="DELUCE")
+    sidereal_chart = KerykeionChartSVG(sidereal_subject)
+    sidereal_chart.makeSVG()
+
+    # Sidereal Birth Chart (J2000)
+    sidereal_subject = AstrologicalSubject("John Lennon J2000", 1940, 10, 9, 10, 30, "Liverpool", "GB", zodiac_type="Sidereal", sidereal_mode="J2000")
+    sidereal_chart = KerykeionChartSVG(sidereal_subject)
+    sidereal_chart.makeSVG()