kerykeion 4.10.0__tar.gz → 4.10.1__tar.gz

{kerykeion-4.10.0 → kerykeion-4.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kerykeion
-Version: 4.10.0
+Version: 4.10.1
 Summary: A python library for astrology.
 Home-page: https://github.com/g-battaglia/kerykeion
 License: AGPL-3.0
@@ -28,8 +28,8 @@ Classifier: Typing :: Typed
 Requires-Dist: pydantic (>=2.5,<3.0)
 Requires-Dist: pyswisseph (>=2.10.3.1,<3.0.0.0)
 Requires-Dist: pytz (>=2022.7,<2023.0)
-Requires-Dist: requests (>=2.28.1,<3.0.0)
-Requires-Dist: requests-cache (>=0.9.7,<0.10.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: requests-cache (>=1.2.1,<2.0.0)
 Requires-Dist: scour (>=0.38.2,<0.39.0)
 Requires-Dist: terminaltables (>=3.1.10,<4.0.0)
 Project-URL: Repository, https://github.com/g-battaglia/kerykeion
@@ -48,7 +48,7 @@ Description-Content-Type: text/markdown
     </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>
@@ -137,7 +137,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
@@ -176,7 +176,7 @@ report.print_report()
 
 Returns:
 
-```
+```bash
 +- Kerykeion report for Kanye -+
 +----------+------+-------------+-----------+----------+
 | Date     | Time | Location    | Longitude | Latitude |
@@ -222,7 +222,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
@@ -244,6 +244,18 @@ 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")
+```
+
+More examples [here](https://www.kerykeion.net/docs/examples/sidereal-modes/).
+
+Full list of supported sidereal modes [here](https://www.kerykeion.net/pydocs/kerykeion/kr_types/kr_literals.html#SiderealMode).
+
 ## Documentation
 
 Most of the functions and the classes are self documented by the types and have docstrings.
@@ -266,5 +278,5 @@ 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.
 

{kerykeion-4.10.0 → kerykeion-4.10.1}/README.md

@@ -11,7 +11,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>
@@ -100,7 +100,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
@@ -139,7 +139,7 @@ report.print_report()
 
 Returns:
 
-```
+```bash
 +- Kerykeion report for Kanye -+
 +----------+------+-------------+-----------+----------+
 | Date     | Time | Location    | Longitude | Latitude |
@@ -185,7 +185,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
@@ -207,6 +207,18 @@ 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")
+```
+
+More examples [here](https://www.kerykeion.net/docs/examples/sidereal-modes/).
+
+Full list of supported sidereal modes [here](https://www.kerykeion.net/pydocs/kerykeion/kr_types/kr_literals.html#SiderealMode).
+
 ## Documentation
 
 Most of the functions and the classes are self documented by the types and have docstrings.
@@ -229,4 +241,4 @@ 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.

{kerykeion-4.10.0 → kerykeion-4.10.1}/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-4.10.0 → kerykeion-4.10.1}/kerykeion/astrological_subject.py

@@ -26,7 +26,7 @@ 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"
@@ -177,7 +177,10 @@ class AstrologicalSubject:
         self.disable_chiron = disable_chiron
         self.sidereal_mode = sidereal_mode
 
-        # Sidereal mode check and setup --->
+        # 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!")
         
@@ -186,11 +189,15 @@ class AstrologicalSubject:
             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_" + sidereal_mode
+            mode = "SIDM_" + self.sidereal_mode
             swe.set_sid_mode(getattr(swe, mode))
             logging.debug(f"Using sidereal mode: {mode}")
-        # <--- Sidereal mode check and setup
+        # <--- 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:
@@ -581,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
@@ -589,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:
@@ -634,4 +641,5 @@ if __name__ == "__main__":
     print(johnny.chiron)
 
     # With Sidereal Zodiac
-    johnny = AstrologicalSubject("Johnny Depp", 1963, 6, 9, 0, 0, "Owensboro", "US", zodiac_type="Sidereal", sidereal_mode="FAGAN_BRADLEY")
+    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-4.10.0 → kerykeion-4.10.1}/kerykeion/kr_types/kr_models.py

@@ -7,7 +7,7 @@
 from typing import Union, Optional
 from pydantic import BaseModel
 
-from kerykeion.kr_types import LunarPhaseEmoji, LunarPhaseName, Planet, Houses, Quality, Element, Sign, ZodiacType, SignNumbers, HouseNumbers, PointType
+from kerykeion.kr_types import LunarPhaseEmoji, LunarPhaseName, Planet, Houses, Quality, Element, Sign, ZodiacType, SignNumbers, HouseNumbers, PointType, SiderealMode
 
 class SubscriptableBaseModel(BaseModel):
     """
@@ -65,6 +65,7 @@ class AstrologicalSubjectModel(SubscriptableBaseModel):
     lat: float
     tz_str: str
     zodiac_type: ZodiacType
+    sidereal_mode: Union[SiderealMode, None]
     local_time: float
     utc_time: float
     julian_day: float

{kerykeion-4.10.0 → kerykeion-4.10.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kerykeion"
-version = "4.10.0"
+version = "4.10.1"
 authors = ["Giacomo Battaglia <battaglia.giacomo@yahoo.it>"]
 description = "A python library for astrology."
 license = "AGPL-3.0"
@@ -44,11 +44,11 @@ packages = [{ include = "kerykeion" }]
 python = "^3.9"
 pyswisseph = "^2.10.3.1"
 pytz = "^2022.7"
-requests = "^2.28.1"
-requests-cache = "^0.9.7"
 pydantic = "^2.5"
 terminaltables = "^3.1.10"
 scour = "^0.38.2"
+requests-cache = "^1.2.1"
+requests = "^2.32.3"
 
 [tool.poetry.scripts]
 create-docs = "scripts.docs:main"
@@ -56,7 +56,7 @@ create-docs = "scripts.docs:main"
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.2.0"
 mypy = "^0.991"
-black = "^22.12.0"
+black = "^24.4.2"
 pdoc = "^14.5.0"
 types-requests = "^2.28.11.7"
 types-pytz = "^2022.7.0.0"
@@ -65,7 +65,7 @@ poethepoet = "^0.19.0"
 # MyPy Static Analysis
 [tool.mypy]
 ignore_missing_imports = true
-mypy_path = "kerkeion"
+mypy_path = "kerykeion"
 files = "kerykeion"
 
 # PyTest Automated Testing