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

kerykeion/__init__.py

@@ -1,100 +1,237 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2024 Giacomo Battaglia
+<h1 align=center>Kerykeion</h1>
+<div align="center">
+    <a href="#">
+        <img src="https://img.shields.io/github/contributors/g-battaglia/kerykeion?color=blue&logo=github" alt="contributors">
+    </a>
+    <a href="#">
+        <img src="https://img.shields.io/github/stars/g-battaglia/kerykeion.svg?logo=github" alt="stars">
+    </a>
+    <a href="#">
+        <img src="https://img.shields.io/github/forks/g-battaglia/kerykeion.svg?logo=github" alt="forks">
+    </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 href="https://pypi.org/project/kerykeion" target="_blank">
+        <img src="https://img.shields.io/pypi/v/kerykeion?label=pypi%20package" alt="Package version">
+    </a>
+    <a href="https://pypi.org/project/kerykeion" target="_blank">
+        <img src="https://img.shields.io/pypi/pyversions/kerykeion.svg" alt="Supported Python versions">
+    </a>
+</div>
 
-    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.
+&nbsp;
 
-    Here some examples:
+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.
 
-    ```python
+The core goal of this project is to provide a simple and easy approach to astrology in a data driven way.
 
-    # Import the main class for creating a kerykeion instance:
-    >>> from kerykeion import AstrologicalSubject
+Here's an example of a birthchart:
 
-    # Create a kerykeion instance:
-    # Args: Name, year, month, day, hour, minuts, city, nation(optional)
-    >>> kanye = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta")
+![Kanye Birth Chart](http://centuryboy.altervista.org/KanyeNatalChart.svg)
 
-    # 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}
+## Web API
 
-    # 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': '♋️'}
+If you want to use Kerykeion in a web application, I've created a web API for this purpose, you can find it here:
 
-    # Get element of the moon sign:
-    >>> kanye.moon.get("element")
-    'Water'
+**[AstrologerAPI](https://rapidapi.com/gbattaglia/api/astrologer/)**
 
-    ```
+It's [open source](https://github.com/g-battaglia/Astrologer-API), it's a way to support me and the project.
 
-    ## Generate a SVG of the birthchart:
+## Donate
 
-    ```python
-    >>> from kerykeion import AstrologicalSubject, KerykeionChartSVG
+Maintaining this project is a lot of work, the Astrologer API doesn't nearly cover the costs of a software engineer working on this project full time. I do this because I love it, but until I can make this my full time job, I won't be able to spend as much time on it.
 
-    >>> first = AstrologicalSubject("Jack", 1990, 6, 15, 15, 15, "Roma")
-    >>> second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma")
+If you want to support me, you can do it here:
 
-    # Set the type, it can be Natal, Synastry or Transit
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/kerykeion)
 
-    >>> 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
+## Installation
 
-    ```
+Kerykeion is a _Python 3.9_ package, make sure you have _Python 3.9_ or above installed on your system.
 
-    ![alt text](http://centuryboy.altervista.org/JackSynastry_Chart.svg)
+```bash
+pip3 install kerykeion
+```
 
+## Usage
 
-    ## Other exeples of possibles usecase
+Here some examples:
 
-    ```python
-    # Get all aspects between two persons:
+```python
 
-    >>> from kerykeion import SynastryAspects, AstrologicalSubject
-    >>> first = AstrologicalSubject("Jack", 1990, 6, 15, 15, 15, "Roma")
-    >>> second = AstrologicalSubject("Jane", 1991, 10, 25, 21, 00, "Roma")
+# Import the main class for creating a kerykeion instance:
+from kerykeion import AstrologicalSubject
 
-    >>> name = SynastryAspects(first, second)
-    >>> aspect_list = name.relevant_aspects
-    >>> print(aspect_list[0])
+# Create a kerykeion instance:
+# Args: Name, year, month, day, hour, minuts, city, nation(optional)
+kanye = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta")
 
-    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}
+# 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}
 
-    ## Documentation
+# Get information about the first house:
+kanye.first_house
 
-    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).
+#> {'name': 'First_House', 'quality': 'Cardinal', 'element': 'Water', 'sign': 'Can', 'sign_num': 3, 'pos': 17.995779673209114, 'abs_pos': 107.99577967320911, 'emoji': '♋️'}
 
-    Sooner or later I'll try to write an extensive documentation.
+# Get element of the moon sign:
+kanye.moon.element
 
-    ## Installation
+#> 'Water'
 
-    Kerykeion is a Python 3 package, make sure you have Python 3 installed on your system.
+```
 
-    ## Development
+**To avoid connecting to GeoNames (eg. avoiding hourly limit or no internet connection) you should instance kerykeion like this:**
 
-    You can clone this repository or download a zip file using the right side buttons.
+```python
+kanye = AstrologicalSubject(
+    "Kanye", 1977, 6, 8, 8, 45, lng=50, lat=50, tz_str="Europe/Rome", city="Rome"
+)
+```
 
-    ## Contributing
+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.
 
-    Feel free to contribute to the code!
+## Generate a SVG Chart:
+
+```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
+
+```
+
+![Synastry Chart](http://centuryboy.altervista.org/JackComposite_Chart.svg)
+
+# Report
+
+To print a report of all the data:
+
+```python
+from kerykeion import Report, AstrologicalSubject
+
+kanye = AstrologicalSubject("Kanye", 1977, 6, 8, 8, 45, "Atlanta")
+report = Report(kanye)
+report.print_report()
+
+```
+
+Returns:
+
+```
++- Kerykeion report for Kanye -+
++----------+------+-------------+-----------+----------+
+| Date     | Time | Location    | Longitude | Latitude |
++----------+------+-------------+-----------+----------+
+| 8/6/1977 | 8:45 | Atlanta, US | -84.38798 | 33.749   |
++----------+------+-------------+-----------+----------+
++-----------+------+-------+------+----------------+
+| Planet    | Sign | Pos.  | Ret. | House          |
++-----------+------+-------+------+----------------+
+| Sun       | Gem  | 17.6  | -    | Twelfth_House  |
+| Moon      | Pis  | 16.43 | -    | Ninth_House    |
+| Mercury   | Tau  | 26.29 | -    | Eleventh_House |
+| Venus     | Tau  | 2.03  | -    | Tenth_House    |
+| Mars      | Tau  | 1.79  | -    | Tenth_House    |
+| Jupiter   | Gem  | 14.61 | -    | Eleventh_House |
+| Saturn    | Leo  | 12.8  | -    | Second_House   |
+| Uranus    | Sco  | 8.27  | R    | Fourth_House   |
+| Neptune   | Sag  | 14.69 | R    | Fifth_House    |
+| Pluto     | Lib  | 11.45 | R    | Fourth_House   |
+| Mean_Node | Lib  | 21.49 | R    | Fourth_House   |
+| True_Node | Lib  | 22.82 | R    | Fourth_House   |
+| Chiron    | Tau  | 4.17  | -    | Tenth_House    |
++-----------+------+-------+------+----------------+
++----------------+------+----------+
+| House          | Sign | Position |
++----------------+------+----------+
+| First_House    | Can  | 18.0     |
+| Second_House   | Leo  | 9.51     |
+| Third_House    | Vir  | 4.02     |
+| Fourth_House   | Lib  | 3.98     |
+| Fifth_House    | Sco  | 9.39     |
+| Sixth_House    | Sag  | 15.68    |
+| Seventh_House  | Cap  | 18.0     |
+| Eighth_House   | Aqu  | 9.51     |
+| Ninth_House    | Pis  | 4.02     |
+| Tenth_House    | Ari  | 3.98     |
+| Eleventh_House | Tau  | 9.39     |
+| Twelfth_House  | Gem  | 15.68    |
++----------------+------+----------+
+
+```
+
+And if you want to export it to a file:
+
+```bash
+$ python3 your_script_name.py > file.txt
+```
+
+## 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://www.kerykeion.net/pydocs/kerykeion.html).
+
+Sooner or later I'll try to write an extensive documentation.
+
+## Development
+
+You can clone this repository or download a zip file using the right side buttons.
+
+## Contributing
+
+Feel free to contribute to the code!
+
+## 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.
+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.
 
 """
 

kerykeion/astrological_subject.py

@@ -15,6 +15,7 @@ from kerykeion.kr_types import (
     AstrologicalSubjectModel,
     LunarPhaseModel,
     KerykeionPointModel,
+    PointType
 )
 from kerykeion.utilities import (
     get_number_from_name, 
@@ -24,7 +25,7 @@ from kerykeion.utilities import (
     get_moon_phase_name_from_phase_int,
 )
 from pathlib import Path
-from typing import Union, Literal
+from typing import Union
 
 DEFAULT_GEONAMES_USERNAME = "century.boy"
 
@@ -330,7 +331,7 @@ class AstrologicalSubject:
         else:
             raise KerykeionException("Zodiac type not recognized! Please use 'Tropic' or 'Sidereal'")
 
-        point_type: Literal["Planet", "House"] = "House"
+        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.
@@ -412,7 +413,7 @@ class AstrologicalSubject:
         """Defines body positon in signs and information and
         stores them in dictionaries"""
 
-        point_type: Literal["Planet", "House"] = "Planet"
+        point_type: PointType = "Planet"
         # stores the planets in singular dictionaries.
         self.sun = calculate_position(self.planets_degrees_ut[0], "Sun", point_type=point_type)
         self.moon = calculate_position(self.planets_degrees_ut[1], "Moon", point_type=point_type)
@@ -474,13 +475,13 @@ class AstrologicalSubject:
 
         # Check in retrograde or not:
         planets_ret = []
-        for p in self.planets_list:
-            planet_number = get_number_from_name(p["name"])
+        for planet in self.planets_list:
+            planet_number = get_number_from_name(planet["name"])
             if swe.calc(self.julian_day, planet_number, self._iflag)[0][3] < 0:
-                p["retrograde"] = True
+                planet["retrograde"] = True
             else:
-                p["retrograde"] = False
-            planets_ret.append(p)
+                planet["retrograde"] = False
+            planets_ret.append(planet)
 
     def _lunar_phase_calc(self) -> None:
         """Function to calculate the lunar phase"""
@@ -577,7 +578,6 @@ class AstrologicalSubject:
 
         KrData = AstrologicalSubjectModel(**self.__dict__)
         json_string = KrData.model_dump_json(exclude_none=True)
-        print(json_string)
 
         if dump:
             if destination_folder:

kerykeion/charts/charts_utils.py

@@ -126,7 +126,7 @@ def draw_zodiac_slice(
 
     Args:
         - c1 (Union[int, float]): The value of c1.
-        - chart_type (Literal["Natal", "ExternalNatal", "Synastry", "Transit"]): The type of chart.
+        - chart_type (ChartType): The type of chart.
         - seventh_house_degree_ut (Union[int, float]): The degree of the seventh house.
         - num (int): The number of the sign. Note: In OpenAstro it did refer to self.zodiac,
             which is a list of the signs in order, starting with Aries. Eg:

kerykeion/kr_types/kr_literals.py

@@ -1,68 +1,53 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2024 Giacomo Battaglia
+This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
-
-
 from typing import Literal
 
-# Zodiac Types:
+
 ZodiacType = Literal["Tropic", "Sidereal"]
+"""Literal type for Zodiac Types"""
+
+
+Sign = Literal["Ari", "Tau", "Gem", "Can", "Leo", "Vir", "Lib", "Sco", "Sag", "Cap", "Aqu", "Pis"]
+"""Literal type for Zodiac Signs"""
+
+
+SignNumbers = Literal[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
+"""Literal type for Zodiac Sign Numbers"""
+
+
+Houses = Literal["First_House", "Second_House", "Third_House", "Fourth_House", "Fifth_House", "Sixth_House", "Seventh_House", "Eighth_House", "Ninth_House", "Tenth_House", "Eleventh_House", "Twelfth_House"]
+"""Literal type for Houses"""
+
+
+HouseNumbers = Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
+"""Literal type for House Numbers"""
+
+
+Planet = Literal["Sun", "Moon", "Mercury", "Venus", "Mars", "Jupiter", "Saturn", "Uranus", "Neptune", "Pluto", "Mean_Node", "True_Node", "Chiron"]
+"""Literal type for Planets"""
 
-# Sings:
-Sign = Literal[
-    "Ari", "Tau", "Gem", "Can", "Leo", "Vir", "Lib", "Sco", "Sag", "Cap", "Aqu", "Pis"
-]
-
-Houses = Literal[
-    "First_House",
-    "Second_House",
-    "Third_House",
-    "Fourth_House",
-    "Fifth_House",
-    "Sixth_House",
-    "Seventh_House",
-    "Eighth_House",
-    "Ninth_House",
-    "Tenth_House",
-    "Eleventh_House",
-    "Twelfth_House",
-]
-
-Planet = Literal[
-    "Sun",
-    "Moon",
-    "Mercury",
-    "Venus",
-    "Mars",
-    "Jupiter",
-    "Saturn",
-    "Uranus",
-    "Neptune",
-    "Pluto",
-    "Mean_Node",
-    "True_Node",
-    "Chiron",
-]
 
 Element = Literal["Air", "Fire", "Earth", "Water"]
+"""Literal type for Elements"""
+
+
+Quality = Literal["Cardinal", "Fixed", "Mutable"]
+"""Literal type for Qualities"""
 
-Quality = Literal[
-    "Cardinal",
-    "Fixed",
-    "Mutable",
-]
 
 ChartType = Literal["Natal", "ExternalNatal", "Synastry", "Transit"]
+"""Literal type for Chart Types"""
+
+
+PointType = Literal["Planet", "House"]
+"""Literal type for Point Types"""
+
 
 LunarPhaseEmoji = Literal["🌑", "🌒", "🌓", "🌔", "🌕", "🌖", "🌗", "🌘"]
-LunarPhaseName = Literal[
-        "New Moon", 
-        "Waxing Crescent", 
-        "First Quarter", 
-        "Waxing Gibbous", 
-        "Full Moon", 
-        "Waning Gibbous", 
-        "Last Quarter", 
-        "Waning Crescent"
-    ]
+"""Literal type for Lunar Phases Emoji"""
+
+
+LunarPhaseName = Literal["New Moon", "Waxing Crescent", "First Quarter", "Waxing Gibbous", "Full Moon", "Waning Gibbous", "Last Quarter", "Waning Crescent"]
+"""Literal type for Lunar Phases Name"""

kerykeion/kr_types/kr_models.py

@@ -4,43 +4,15 @@
 """
 
 
-from typing import Literal, Union, Optional
+from typing import Union, Optional
 from pydantic import BaseModel
 
-from kerykeion.kr_types import LunarPhaseEmoji, LunarPhaseName, Planet, Houses, Quality, Element, Sign, ZodiacType
-
-
-class LunarPhaseModel(BaseModel):
-    degrees_between_s_m: Union[float, int]
-    moon_phase: int
-    sun_phase: int
-    moon_emoji: LunarPhaseEmoji
-    moon_phase_name: LunarPhaseName
-
-    def __str__(self):
-        return (
-            super()
-            .model_dump(
-                exclude_none=True,
-                exclude_unset=True,
-                exclude_defaults=True,
-                by_alias=False,
-            )
-            .__str__()
-        )
-
-    def __repr__(self):
-        return (
-            super()
-            .model_dump(
-                exclude_none=True,
-                exclude_unset=True,
-                exclude_defaults=True,
-                by_alias=False,
-            )
-            .__str__()
-        )
+from kerykeion.kr_types import LunarPhaseEmoji, LunarPhaseName, Planet, Houses, Quality, Element, Sign, ZodiacType, SignNumbers, HouseNumbers, PointType
 
+class SubscriptableBaseModel(BaseModel):
+    """
+    Pydantic BaseModel with subscriptable support, so you can access the fields as if they were a dictionary.
+    """
     def __getitem__(self, key):
         return getattr(self, key)
 
@@ -53,8 +25,15 @@ class LunarPhaseModel(BaseModel):
     def get(self, key, default):
         return getattr(self, key, default)
 
+class LunarPhaseModel(SubscriptableBaseModel):
+    degrees_between_s_m: Union[float, int]
+    moon_phase: int
+    sun_phase: int
+    moon_emoji: LunarPhaseEmoji
+    moon_phase_name: LunarPhaseName
+
 
-class KerykeionPointModel(BaseModel):
+class KerykeionPointModel(SubscriptableBaseModel):
     """
     Kerykeion Point Model
     """
@@ -63,52 +42,16 @@ class KerykeionPointModel(BaseModel):
     quality: Quality
     element: Element
     sign: Sign
-    sign_num: Literal[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
+    sign_num: SignNumbers
     position: float
     abs_pos: float
     emoji: str
-    point_type: Literal["Planet", "House"]
-    house: Optional[Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]] = None
+    point_type: PointType
+    house: Optional[HouseNumbers] = None
     retrograde: Optional[bool] = None
 
-    def __str__(self):
-        return (
-            super()
-            .model_dump(
-                exclude_none=True,
-                exclude_unset=True,
-                exclude_defaults=True,
-                by_alias=False,
-            )
-            .__str__()
-        )
-
-    def __repr__(self):
-        return (
-            super()
-            .model_dump(
-                exclude_none=True,
-                exclude_unset=True,
-                exclude_defaults=True,
-                by_alias=False,
-            )
-            .__str__()
-        )
-
-    def __getitem__(self, key):
-        return getattr(self, key)
-
-    def __setitem__(self, key, value):
-        setattr(self, key, value)
 
-    def __delitem__(self, key):
-        delattr(self, key)
-
-    def get(self, key, default):
-        return getattr(self, key, default)
-
-
-class AstrologicalSubjectModel(BaseModel):
+class AstrologicalSubjectModel(SubscriptableBaseModel):
     # Data
     name: str
     year: int
@@ -137,6 +80,8 @@ class AstrologicalSubjectModel(BaseModel):
     uranus: KerykeionPointModel
     neptune: KerykeionPointModel
     pluto: KerykeionPointModel
+
+    # Optional Planets:
     chiron: Union[KerykeionPointModel, None]
 
     # Houses

kerykeion/kr_types/settings_models.py

@@ -4,29 +4,12 @@
 """
 
 
-from pydantic import BaseModel, Field
+from pydantic import Field
 from typing import List
+from kerykeion.kr_types.kr_models import SubscriptableBaseModel
 
 
-class CustomBaseModel(BaseModel):
-    """
-    Extends the BaseModel class of Pydantic to add some useful methods.
-    """
-
-    def __init__(self, **data):
-        super().__init__(**data)
-
-    def __getitem__(self, item):
-        return getattr(self, item)
-    
-    def __str__(self) -> str:
-        return str(self.model_dump())
-
-    def get(self, item, default=None):
-        return getattr(self, item, default)
-
-
-class KerykeionSettingsCelestialPointModel(CustomBaseModel):
+class KerykeionSettingsCelestialPointModel(SubscriptableBaseModel):
     """
     Defines the model for a celestial point data.
     """
@@ -41,7 +24,7 @@ class KerykeionSettingsCelestialPointModel(CustomBaseModel):
 
 
 # Chart Colors Settings
-class KerykeionSettingsChartColorsModel(CustomBaseModel):
+class KerykeionSettingsChartColorsModel(SubscriptableBaseModel):
     """
     Defines the model for the chart colors.
     """
@@ -87,7 +70,7 @@ class KerykeionSettingsChartColorsModel(CustomBaseModel):
 
 
 # Aspect Settings
-class KerykeionSettingsAspectModel(CustomBaseModel):
+class KerykeionSettingsAspectModel(SubscriptableBaseModel):
     """
     Defines the model for an aspect.
     """
@@ -103,7 +86,7 @@ class KerykeionSettingsAspectModel(CustomBaseModel):
 
 
 # Language Settings
-class KerykeionLanguageCelestialPointModel(CustomBaseModel):
+class KerykeionLanguageCelestialPointModel(SubscriptableBaseModel):
     """
     This class is used to define the labels, show in the chart, for the celestial points.
     It is used to translate the celestial points in the language of the chart.
@@ -128,7 +111,7 @@ class KerykeionLanguageCelestialPointModel(CustomBaseModel):
     Ic: str = Field(title="Imum Coeli", description="The name of Imum Coeli in the chart, in the language")
 
 
-class KerykeionLanguageModel(CustomBaseModel):
+class KerykeionLanguageModel(SubscriptableBaseModel):
     """
     This model is used to store the language settings for the chart,
     it's used to translate the celestial points and the other labels
@@ -157,17 +140,17 @@ class KerykeionLanguageModel(CustomBaseModel):
     celestial_points: KerykeionLanguageCelestialPointModel
 
 
-class KerykeionGeneralSettingsModel(CustomBaseModel):
+class KerykeionGeneralSettingsModel(SubscriptableBaseModel):
     axes_orbit: int = Field(title="Axes Orbit", description="The orbit of the axes in the chart")
     planet_in_zodiac_extra_points: int = Field(title="Planet in Zodiac Extra Points", description="The extra points of the planet in the zodiac")
     language: str = Field(title="Language", description="The language of the chart")
 
-class KerykeionChartSettingsModel(CustomBaseModel):
+class KerykeionChartSettingsModel(SubscriptableBaseModel):
     basic_chart_viewBox: str = Field(title="Basic Chart ViewBox", description="The viewbox of the basic chart")
     wide_chart_viewBox: str = Field(title="Wide Chart ViewBox", description="The viewbox of the wide chart")
 
 # Settings Model
-class KerykeionSettingsModel(CustomBaseModel):
+class KerykeionSettingsModel(SubscriptableBaseModel):
     """
     This class is used to define the global settings for the Kerykeion.
     """

kerykeion/utilities.py

@@ -1,47 +1,46 @@
 from kerykeion.kr_types import KerykeionPointModel, KerykeionException, KerykeionSettingsModel, AstrologicalSubjectModel
-from kerykeion.kr_types.kr_literals import LunarPhaseEmoji, LunarPhaseName
-from typing import Union, Literal
+from kerykeion.kr_types.kr_literals import LunarPhaseEmoji, LunarPhaseName, PointType, Planet
+from typing import Union
 import logging
 import math
 
 
 
-def get_number_from_name(name: str) -> int:
+def get_number_from_name(name: Planet) -> int:
     """Utility function, gets planet id from the name."""
-    name = name.lower()
 
-    if name == "sun":
+    if name == "Sun":
         return 0
-    elif name == "moon":
+    elif name == "Moon":
         return 1
-    elif name == "mercury":
+    elif name == "Mercury":
         return 2
-    elif name == "venus":
+    elif name == "Venus":
         return 3
-    elif name == "mars":
+    elif name == "Mars":
         return 4
-    elif name == "jupiter":
+    elif name == "Jupiter":
         return 5
-    elif name == "saturn":
+    elif name == "Saturn":
         return 6
-    elif name == "uranus":
+    elif name == "Uranus":
         return 7
-    elif name == "neptune":
+    elif name == "Neptune":
         return 8
-    elif name == "pluto":
+    elif name == "Pluto":
         return 9
-    elif name == "mean_node":
+    elif name == "Mean_Node":
         return 10
-    elif name == "true_node":
+    elif name == "True_Node":
         return 11
-    elif name == "chiron":
+    elif name == "Chiron":
         return 15
     else:
-        return int(name)
+        raise KerykeionException(f"Error in getting number from name! Name: {name}")
 
 
 def calculate_position(
-    degree: Union[int, float], number_name: str, point_type: Literal["Planet", "House"]
+    degree: Union[int, float], number_name: str, point_type: PointType
 ) -> KerykeionPointModel:
     """Utility function to create a dictionary dividing the houses or the planets list."""
 
@@ -214,14 +213,14 @@ def setup_logging(level: str) -> None:
     Args:
         level: Log level as a string, options: debug, info, warning, error
     """
-    logopt: dict[str, int] = {
+    logging_options: dict[str, int] = {
         "debug": logging.DEBUG,
         "info": logging.INFO,
         "warning": logging.WARNING,
         "error": logging.ERROR,
     }
     format: str = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
-    loglevel: int = logopt.get(level, logging.INFO)
+    loglevel: int = logging_options.get(level, logging.INFO)
     logging.basicConfig(format=format, level=loglevel)
 
 def check_if_point_between(

{kerykeion-4.8.1.dist-info → kerykeion-4.9.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kerykeion
-Version: 4.8.1
+Version: 4.9.1
 Summary: A python library for astrology.
 Home-page: https://github.com/g-battaglia/kerykeion
 License: AGPL-3.0
@@ -247,7 +247,7 @@ print(aspect_list[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).
+An auto-generated documentation [is available here](https://www.kerykeion.net/pydocs/kerykeion.html).
 
 Sooner or later I'll try to write an extensive documentation.
 

{kerykeion-4.8.1.dist-info → kerykeion-4.9.1.dist-info}/RECORD

@@ -1,12 +1,12 @@
 LICENSE,sha256=UTLH8EdbAsgQei4PA2PnBCPGLSZkq5J-dhkyJuXgWQU,34273
-kerykeion/__init__.py,sha256=Z2-gAp09RAl2_WwzPO-OTc4ZRDLh54kTduAoy891gQc,3917
+kerykeion/__init__.py,sha256=mJ7NjiDlBLjQAm1--jf1D-zZAUAm5RkNWMZFIZV3mPM,9050
 kerykeion/aspects/__init__.py,sha256=9FlDVI1ndCJga0-chNIhcLitjU_x3kbtAFfFqVp2ejc,293
 kerykeion/aspects/aspects_utils.py,sha256=Rdo3ITDSU80n6U7aazpzzK4ruv7Iui2PaI3zMGqu1NQ,5832
 kerykeion/aspects/natal_aspects.py,sha256=m3_v1dM6YXvENZ6iN_EJkikKxySZBeR5QKhGsaChERk,4507
 kerykeion/aspects/synastry_aspects.py,sha256=uwg7Lc7wKnpxW9ydOdBHqx9cvO_t0ydGfIGluBIDD7c,3993
-kerykeion/astrological_subject.py,sha256=Z9QUNqX6mrOm4ihxmhH0hiMv6ilp_-0HCQ4u_feE73g,22956
+kerykeion/astrological_subject.py,sha256=ufYhARWxrrfQ14S7Vjb_ApwAU_cwd3lND3H7KnY3k7I,22925
 kerykeion/charts/__init__.py,sha256=Juxkduy2TaagWblh_7CE8Acrg3dHL27-WEddJhau_eQ,127
-kerykeion/charts/charts_utils.py,sha256=45Ee0Hj5nb30q97ggYTQEShxkbCPq65gI0-sE32UxDM,15112
+kerykeion/charts/charts_utils.py,sha256=Pfy-SkPnABIy5ZkKgypnGqxXOAKhTRIeQX3fQKO8DgQ,15065
 kerykeion/charts/kerykeion_chart_svg.py,sha256=vtTYgwXELnZoPKvySpEQRLZSaYVzzpDQBcUk9DwnQjw,60764
 kerykeion/charts/templates/chart.xml,sha256=njaX-1vglR7PFInmteCNHcxwMTjsMJPkW56TlJq0qxw,70158
 kerykeion/enums.py,sha256=Ben9GLYkPucpYY2ZDpURzUbNCc9jzK2MuaffkgiXFdQ,965
@@ -14,9 +14,9 @@ kerykeion/fetch_geonames.py,sha256=ZWB1DbcH54ab3fQhzPhLY0Dz0OaPJqiHFn2e7DRr1MM,4
 kerykeion/kr_types/__init__.py,sha256=-qhGQikurdoHnGtuT1bsaEeZ-IwmZtIHMjGOPC9_oqQ,295
 kerykeion/kr_types/chart_types.py,sha256=g9z53FTOsb2rusUG8nK4dtFgvVa6RCwAfAbrxFb9KaM,2180
 kerykeion/kr_types/kerykeion_exception.py,sha256=G-7VFta78qBt10l54JZWvwH-3lUNKmDwuILXaVGVu9A,314
-kerykeion/kr_types/kr_literals.py,sha256=Kc7LfdeTqHi5uDGoQHWsB81GTBc5E-fGxTJqWKK1FFU,1267
-kerykeion/kr_types/kr_models.py,sha256=3gyT4z-J9EM6p5175HKJX9q9WVWQTDt5Y_m3m8lZu9s,4260
-kerykeion/kr_types/settings_models.py,sha256=V4iEj7egXZHrWiV1cGQIezbtVmOKbOB-BRzPwa8WVtc,12683
+kerykeion/kr_types/kr_literals.py,sha256=uNWy9uLKPctGhX8CgZ6qXT4J38K9MMF5JDH6eQmbbSY,1641
+kerykeion/kr_types/kr_models.py,sha256=kAIpJcST4818qVG26qw6Nv9MXaSsR4uFPIINSiSLkA0,3054
+kerykeion/kr_types/settings_models.py,sha256=Gh467QjvlGmheD6eJI1IHpuK4cz_hbtjGTJT_1NMoAE,12376
 kerykeion/relationship_score.py,sha256=R9JugfK5_gJgr5ND-EghkqpqZcutzzKlJ-2JnYUMVv4,6794
 kerykeion/report.py,sha256=kS5avIN119pJVapYjZOvabg77nEcA8sSrOuXbRifABk,2565
 kerykeion/settings/__init__.py,sha256=QQNFCl7sgN27MKaVscqtpPk10HGz4wZS3I_7KEGMaVA,69
@@ -24,9 +24,9 @@ kerykeion/settings/kerykeion_settings.py,sha256=uRAbhJ0ZXAbGBPGJjhh5u8YX2phcXobE
 kerykeion/settings/kr.config.json,sha256=1Yhv9RGHom5U9e-JZZRWVfT2Ubllz2WrckdwadDWfyg,12282
 kerykeion/sweph/README.md,sha256=L7FtNAJTWtrZNGKa8MX87SjduFYPYxwWhaI5fmtzNZo,73
 kerykeion/sweph/seas_18.se1,sha256=X9nCqhZU43wJpq61WAdueVQJt9xL2UjrwPqn1Kdoa1s,223002
-kerykeion/utilities.py,sha256=ncoXHvzXhNjhdm-uU6hMirVo287laq2GAJElNE6cBZM,10822
-kerykeion-4.8.1.dist-info/LICENSE,sha256=UTLH8EdbAsgQei4PA2PnBCPGLSZkq5J-dhkyJuXgWQU,34273
-kerykeion-4.8.1.dist-info/METADATA,sha256=5KQpaw5C7-Ym6P1S6QJ8pIjMyOn4JlVh3cJrroZmluA,10351
-kerykeion-4.8.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-kerykeion-4.8.1.dist-info/entry_points.txt,sha256=5SmANYscFDDTdeovHvGQ-cnj0hdFvGoxPaWLCpyDFnQ,49
-kerykeion-4.8.1.dist-info/RECORD,,
+kerykeion/utilities.py,sha256=Sb-EdrgvyGgLNxFUNWaMr4DBTbvyTkZjXR_c0ouTCj0,10872
+kerykeion-4.9.1.dist-info/LICENSE,sha256=UTLH8EdbAsgQei4PA2PnBCPGLSZkq5J-dhkyJuXgWQU,34273
+kerykeion-4.9.1.dist-info/METADATA,sha256=RUjpn9jb5R6s4l_L0MDpsC_iYITj49JHYDJvBMI7ioA,10359
+kerykeion-4.9.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+kerykeion-4.9.1.dist-info/entry_points.txt,sha256=5SmANYscFDDTdeovHvGQ-cnj0hdFvGoxPaWLCpyDFnQ,49
+kerykeion-4.9.1.dist-info/RECORD,,