kerykeion 4.0.6__py3-none-any.whl → 4.12.3__py3-none-any.whl

kerykeion/enums.py

@@ -0,0 +1,50 @@
+from enum import Enum
+
+
+class Planets(Enum):
+    SUN = "Sun"
+    MOON = "Moon"
+    MERCURY = "Mercury"
+    VENUS = "Venus"
+    MARS = "Mars"
+    JUPITER = "Jupiter"
+    SATURN = "Saturn"
+    URANUS = "Uranus"
+    NEPTUNE = "Neptune"
+    PLUTO = "Pluto"
+    CHIRON = "Chiron"
+    TRUE_NODE = "True_Node"
+    MEAN_NODE = "Mean_Node"
+
+
+class Aspects(Enum):
+    CONJUNCTION = "Conjunction"
+    SEXTILE = "Sextile"
+    SEMI_SEXTILE = "Semi-Sextile"
+    SQUARE = "Square"
+    TRINE = "Trine"
+    OPPOSITION = "Opposition"
+    QUINCUNX = "Quincunx"
+    NONE = None
+    QUINTILE = "Quintile"
+    BIQUINTILE = "Biquintile"
+    OCTILE = "Octile"
+    TRIOCTILE = "Trioctile"
+    DECILE = "Decile"
+    TRIDECILE = "Tridecile"
+    SESQUIQUADRATE = "Sesquiquadrate"
+
+
+class Signs(Enum):
+    ARI = "Ari"
+    TAU = "Tau"
+    GEM = "Gem"
+    CAN = "Can"
+    LEO = "Leo"
+    VIR = "Vir"
+    LIB = "Lib"
+    SCO = "Sco"
+    SAG = "Sag"
+    CAP = "Cap"
+    AQU = "Aqu"
+    PIS = "Pis"

kerykeion/fetch_geonames.py

@@ -1,22 +1,15 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 
-from logging import getLogger, basicConfig
+import logging
 from requests import Request
 from requests_cache import CachedSession
 from typing import Union
 
 
-logger = getLogger(__name__)
-basicConfig(
-    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
-    level="INFO"
-)
-
-
 class FetchGeonames:
     """
     Class to handle requests to the GeoNames API
@@ -25,8 +18,6 @@ class FetchGeonames:
     city_name (str): Name of the city
     country_code (str): Two letters country code
     username (str, optional): GeoNames username, defaults to "century.boy".
-    logger (Union[logging.Logger, None], optional):
-        Optional logger, defaults to None. If none provided creates one.
     """
 
     def __init__(
@@ -57,21 +48,21 @@ class FetchGeonames:
         params = {"lat": lat, "lng": lon, "username": self.username}
 
         prepared_request = Request("GET", self.timezone_url, params=params).prepare()
-        logger.debug(f"Requesting data from GeoName timezones: {prepared_request.url}")
+        logging.debug(f"Requesting data from GeoName timezones: {prepared_request.url}")
 
         try:
             response = self.session.send(prepared_request)
             response_json = response.json()
 
         except Exception as e:
-            logger.error(f"Error fetching {self.timezone_url}: {e}")
+            logging.error(f"Error fetching {self.timezone_url}: {e}")
             return {}
 
         try:
             timezone_data["timezonestr"] = response_json["timezoneId"]
 
         except Exception as e:
-            logger.error(f"Error serializing data maybe wrong username? Details: {e}")
+            logging.error(f"Error serializing data maybe wrong username? Details: {e}")
             return {}
 
         if hasattr(response, "from_cache"):
@@ -91,18 +82,21 @@ class FetchGeonames:
             "contry": country_code,
             "username": self.username,
             "maxRows": 1,
-            "style": "FULL",
+            "style": "SHORT",
+            "featureClass": "A",
+            "featureClass": "P",
         }
 
         prepared_request = Request("GET", self.base_url, params=params).prepare()
-        logger.debug(f"Requesting data from geonames basic: {prepared_request.url}")
+        logging.debug(f"Requesting data from geonames basic: {prepared_request.url}")
 
         try:
             response = self.session.send(prepared_request)
             response_json = response.json()
+            logging.debug(f"Response from GeoNames: {response_json}")
 
         except Exception as e:
-            logger.error(f"Error in fetching {self.base_url}: {e}")
+            logging.error(f"Error in fetching {self.base_url}: {e}")
             return {}
 
         try:
@@ -112,7 +106,7 @@ class FetchGeonames:
             city_data_whitout_tz["countryCode"] = response_json["geonames"][0]["countryCode"]
 
         except Exception as e:
-            logger.error(f"Error serializing data maybe wrong username? Details: {e}")
+            logging.error(f"Error serializing data maybe wrong username? Details: {e}")
             return {}
 
         if hasattr(response, "from_cache"):
@@ -132,18 +126,15 @@ class FetchGeonames:
             timezone_response = self.__get_timezone(city_data_response["lat"], city_data_response["lng"])
 
         except Exception as e:
-            logger.error(f"Error in fetching timezone: {e}")
+            logging.error(f"Error in fetching timezone: {e}")
             return {}
 
         return {**timezone_response, **city_data_response}
 
 
 if __name__ == "__main__":
-    basicConfig(
-        format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
-        level="DEBUG",
-        force=True,
-    )
+    from kerykeion.utilities import setup_logging
+    setup_logging(level="debug")
 
-    geonames = FetchGeonames("Roma", "IT")
+    geonames = FetchGeonames("Montichiari", "IT")
     print(geonames.get_serialized_data())

kerykeion/kr_types/__init__.py

@@ -1,3 +1,10 @@
+# -*- coding: utf-8 -*-
+"""
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
+"""
+
 from .kerykeion_exception import KerykeionException
 from .kr_literals import *
 from .kr_models import *
+from .chart_types import ChartTemplateDictionary
+from .settings_models import KerykeionSettingsModel

kerykeion/kr_types/chart_types.py

@@ -1,35 +1,26 @@
-from typing import Literal, Union, Optional
-from pydantic import BaseModel
+from typing import TypedDict
 
 
-class ChartTemplateModel(BaseModel):
-    """Pydantic model for the chart template."""
-
-    def __setitem__(self, key, value):
-        setattr(self, key, value)
-
-    def __getitem__(self, key):
-        return getattr(self, key)
-
+class ChartTemplateDictionary(TypedDict):
     transitRing: str
     degreeRing: str
-    c1: str
-    c1style: str
-    c2: str
-    c2style: str
+    first_circle: str
+    second_circle: str
     c3: str
     c3style: str
-    makeAspects: bool
-    makeAspectGrid: bool
-    makePatterns: bool
-    chart_width: int
-    circleX: int
-    circleY: int
-    svgWidth: int
-    svgHeight: int
+    makeAspects: str
+    makeAspectGrid: str
+    makePatterns: str
+    chart_height: float
+    chart_width: float
+    circleX: str
+    circleY: str
+    svgWidth: str
+    svgHeight: str
     viewbox: str
     stringTitle: str
     stringName: str
+    bottomLeft0: str
     bottomLeft1: str
     bottomLeft2: str
     bottomLeft3: str
@@ -39,14 +30,19 @@ class ChartTemplateModel(BaseModel):
     lunar_phase_cx: int
     lunar_phase_r: int
     lunar_phase_outline: str
-    lunar_phase_rotate: int
+    lunar_phase_rotate: float
     stringLocation: str
     stringDateTime: str
     stringLat: str
     stringLon: str
     stringPosition: str
+
+    # Font color
     paper_color_0: str
+    # Background color of the chart
     paper_color_1: str
+    
+    # Planets colors, from 1 to 15 (0 is the Sun)
     planets_color_0: str
     planets_color_1: str
     planets_color_2: str
@@ -63,6 +59,8 @@ class ChartTemplateModel(BaseModel):
     planets_color_13: str
     planets_color_14: str
     planets_color_15: str
+    
+    # Zodiac colors, from 0 to 11 (0 is Aries)
     zodiac_color_0: str
     zodiac_color_1: str
     zodiac_color_2: str
@@ -75,6 +73,8 @@ class ChartTemplateModel(BaseModel):
     zodiac_color_9: str
     zodiac_color_10: str
     zodiac_color_11: str
+
+    # Aspects colors, from 0 to 9 (0 is conjunction)
     orb_color_0: str
     orb_color_30: str
     orb_color_45: str
@@ -86,12 +86,13 @@ class ChartTemplateModel(BaseModel):
     orb_color_144: str
     orb_color_150: str
     orb_color_180: str
-    cfgZoom: float
-    cfgRotate: int
+
+    cfgZoom: str
+    cfgRotate: str
     cfgTranslate: str
-    makeZodiac: bool
-    makeHouses: bool
-    makePlanets: bool
-    makeElements: bool
-    makePlanetGrid: bool
-    makeHousesGrid: bool
+    makeZodiac: str
+    makeHouses: str
+    makePlanets: str
+    elements_percentages: str
+    makePlanetGrid: str
+    makeHousesGrid: str

kerykeion/kr_types/kerykeion_exception.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 

kerykeion/kr_types/kr_literals.py

@@ -1,58 +1,101 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 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, the signs are numbered in order starting from Aries (0) to Pisces (11)"""
+
+
+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, starting from the First House (1) to the Twelfth House (12)"""
+
+
+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["🌑", "🌒", "🌓", "🌔", "🌕", "🌖", "🌗", "🌘"]
+"""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"""
+
+
+SiderealMode = Literal["FAGAN_BRADLEY", "LAHIRI", "DELUCE", "RAMAN", "USHASHASHI", "KRISHNAMURTI", "DJWHAL_KHUL", "YUKTESHWAR", "JN_BHASIN", "BABYL_KUGLER1", "BABYL_KUGLER2", "BABYL_KUGLER3", "BABYL_HUBER", "BABYL_ETPSC", "ALDEBARAN_15TAU", "HIPPARCHOS", "SASSANIAN", "J2000", "J1900", "B1950"]
+"""Literal type for Sidereal Modes, as known as Ayanamsa"""
+
+
+HousesSystemIdentifier = Literal["A", "B", "C", "D", "F", "H", "I", "i", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y"]
+"""
+Literal type for Houses Systems:
+
+A = equal
+B = Alcabitius
+C = Campanus
+D = equal (MC)
+F = Carter poli-equ.
+H = horizon/azimut
+I = Sunshine
+i = Sunshine/alt.
+K = Koch
+L = Pullen SD
+M = Morinus
+N = equal/1=Aries
+O = Porphyry
+P = Placidus
+Q = Pullen SR
+R = Regiomontanus
+S = Sripati
+T = Polich/Page
+U = Krusinski-Pisa-Goelzer
+V = equal/Vehlow
+W = equal/whole sign
+X = axial rotation system/Meridian houses
+Y = APC houses
+
+Usually the standard is Placidus (P)
+"""
+
+
+PerspectiveType = Literal["Apparent Geocentric", "Heliocentric", "Topocentric", "True Geocentric"]
+"""
+Literal type for perspective types.
+- "Apparent Geocentric": Earth-centered, apparent positions.
+- "Heliocentric": Sun-centered.
+- "Topocentric": Observer's location on Earth's surface.
+- "True Geocentric": Earth-centered, true positions.
+
+Usually the standard is "Apparent Geocentric"
+"""

kerykeion/kr_types/kr_models.py

@@ -1,45 +1,18 @@
 # -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2023 Giacomo Battaglia
+    This is part of Kerykeion (C) 2024 Giacomo Battaglia
 """
 
 
-from typing import Literal, Union, Optional
+from typing import Union, Optional
 from pydantic import BaseModel
 
-from .kr_literals import *
-
-
-class LunarPhaseModel(BaseModel):
-    degrees_between_s_m: Union[int, float]
-    moon_phase: int
-    sun_phase: int
-    moon_emoji: LunarPhaseEmoji
-
-    def __str__(self):
-        return (
-            super()
-            .dict(
-                exclude_none=True,
-                exclude_unset=True,
-                exclude_defaults=True,
-                by_alias=False,
-            )
-            .__str__()
-        )
-
-    def __repr__(self):
-        return (
-            super()
-            .dict(
-                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, SiderealMode, HousesSystemIdentifier
 
+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)
 
@@ -52,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
     """
@@ -62,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()
-            .dict(
-                exclude_none=True,
-                exclude_unset=True,
-                exclude_defaults=True,
-                by_alias=False,
-            )
-            .__str__()
-        )
-
-    def __repr__(self):
-        return (
-            super()
-            .dict(
-                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
@@ -121,8 +65,12 @@ class AstrologicalSubjectModel(BaseModel):
     lat: float
     tz_str: str
     zodiac_type: ZodiacType
-    local_time: float
-    utc_time: float
+    sidereal_mode: Union[SiderealMode, None]
+    houses_system_identifier: HousesSystemIdentifier
+    houses_system_name: str
+    perspective_type: str
+    iso_formatted_local_datetime: str
+    iso_formatted_utc_datetime: str
     julian_day: float
 
     # Planets
@@ -137,6 +85,9 @@ class AstrologicalSubjectModel(BaseModel):
     neptune: KerykeionPointModel
     pluto: KerykeionPointModel
 
+    # Optional Planets:
+    chiron: Union[KerykeionPointModel, None]
+
     # Houses
     first_house: KerykeionPointModel
     second_house: KerykeionPointModel
@@ -158,8 +109,21 @@ class AstrologicalSubjectModel(BaseModel):
     # Lunar Phase
     lunar_phase: LunarPhaseModel
 
+    # Deprecated properties
+    utc_time: float
+    local_time: float
+
+    # Lists
+    # houses_list: list[KerykeionPointModel]
+    # planets_list: list[KerykeionPointModel]
+    # planets_degrees_ut: list[float]
+    # houses_degree_ut: list[float]
 
 if __name__ == "__main__":
+    from kerykeion.utilities import setup_logging
+
+    setup_logging(level="debug")
+
     sun = KerykeionPointModel(
         name="Sun",
         element="Air",
@@ -172,5 +136,5 @@ if __name__ == "__main__":
         point_type="Planet",
     )
 
-    print(sun.json())
+    print(sun.model_dump_json())
     print(sun)