kerykeion.kr_types.settings_models

  1# -*- coding: utf-8 -*-
  2"""
  3    This is part of Kerykeion (C) 2025 Giacomo Battaglia
  4"""
  5
  6
  7from pydantic import Field
  8from typing import List, Optional, Union
  9from kerykeion.kr_types.kr_models import SubscriptableBaseModel
 10
 11
 12class KerykeionSettingsCelestialPointModel(SubscriptableBaseModel):
 13    """
 14    Defines the model for a celestial point data.
 15    """
 16
 17    id: int = Field(title="Celestial Point ID", description="Celestial Point ID according to Pyswisseph")
 18    name: str = Field(title="Celestial Point Name", description="Celestial Point Name")
 19    color: str = Field(title="Celestial Point Color", description="Celestial Point Color, used in the chart")
 20    element_points: int = Field(title="Celestial Point Element Points", description="Element Points given to the celestial point")
 21    related_zodiac_signs: List[int] = Field(title="Celestial Point Related Zodiac Signs", description="Zodiac Signs related to the celestial point")
 22    label: str = Field(title="Celestial Point Label", description="The name of the celestial point in the chart, it can be different from the name")
 23    is_active: Optional[bool] = Field(title="Celestial Point is Active", description="Indicates if the celestial point is active in the chart", default=None)
 24
 25
 26# Chart Colors Settings
 27class KerykeionSettingsChartColorsModel(SubscriptableBaseModel):
 28    """
 29    Defines the model for the chart colors.
 30    """
 31
 32    paper_0: str = Field(title="Paper Color 0", description="Paper Color 0")
 33    paper_1: str = Field(title="Paper Color 1", description="Paper Color 1")
 34    zodiac_bg_0: str = Field(title="Zodiac Background Color 0", description="Zodiac Background Color 0")
 35    zodiac_bg_1: str = Field(title="Zodiac Background Color 1", description="Zodiac Background Color 1")
 36    zodiac_bg_2: str = Field(title="Zodiac Background Color 2", description="Zodiac Background Color 2")
 37    zodiac_bg_3: str = Field(title="Zodiac Background Color 3", description="Zodiac Background Color 3")
 38    zodiac_bg_4: str = Field(title="Zodiac Background Color 4", description="Zodiac Background Color 4")
 39    zodiac_bg_5: str = Field(title="Zodiac Background Color 5", description="Zodiac Background Color 5")
 40    zodiac_bg_6: str = Field(title="Zodiac Background Color 6", description="Zodiac Background Color 6")
 41    zodiac_bg_7: str = Field(title="Zodiac Background Color 7", description="Zodiac Background Color 7")
 42    zodiac_bg_8: str = Field(title="Zodiac Background Color 8", description="Zodiac Background Color 8")
 43    zodiac_bg_9: str = Field(title="Zodiac Background Color 9", description="Zodiac Background Color 9")
 44    zodiac_bg_10: str = Field(title="Zodiac Background Color 10", description="Zodiac Background Color 10")
 45    zodiac_bg_11: str = Field(title="Zodiac Background Color 11", description="Zodiac Background Color 11")
 46    zodiac_icon_0: str = Field(title="Zodiac Icon Color 0", description="Zodiac Icon Color 0")
 47    zodiac_icon_1: str = Field(title="Zodiac Icon Color 1", description="Zodiac Icon Color 1")
 48    zodiac_icon_2: str = Field(title="Zodiac Icon Color 2", description="Zodiac Icon Color 2")
 49    zodiac_icon_3: str = Field(title="Zodiac Icon Color 3", description="Zodiac Icon Color 3")
 50    zodiac_icon_4: str = Field(title="Zodiac Icon Color 4", description="Zodiac Icon Color 4")
 51    zodiac_icon_5: str = Field(title="Zodiac Icon Color 5", description="Zodiac Icon Color 5")
 52    zodiac_icon_6: str = Field(title="Zodiac Icon Color 6", description="Zodiac Icon Color 6")
 53    zodiac_icon_7: str = Field(title="Zodiac Icon Color 7", description="Zodiac Icon Color 7")
 54    zodiac_icon_8: str = Field(title="Zodiac Icon Color 8", description="Zodiac Icon Color 8")
 55    zodiac_icon_9: str = Field(title="Zodiac Icon Color 9", description="Zodiac Icon Color 9")
 56    zodiac_icon_10: str = Field(title="Zodiac Icon Color 10", description="Zodiac Icon Color 10")
 57    zodiac_icon_11: str = Field(title="Zodiac Icon Color 11", description="Zodiac Icon Color 11")
 58    zodiac_radix_ring_0: str = Field(title="Zodiac Radix Ring Color 0", description="Zodiac Radix Ring Color 0")
 59    zodiac_radix_ring_1: str = Field(title="Zodiac Radix Ring Color 1", description="Zodiac Radix Ring Color 1")
 60    zodiac_radix_ring_2: str = Field(title="Zodiac Radix Ring Color 2", description="Zodiac Radix Ring Color 2")
 61    zodiac_transit_ring_0: str = Field(title="Zodiac Transit Ring Color 0", description="Zodiac Transit Ring Color 0")
 62    zodiac_transit_ring_1: str = Field(title="Zodiac Transit Ring Color 1", description="Zodiac Transit Ring Color 1")
 63    zodiac_transit_ring_2: str = Field(title="Zodiac Transit Ring Color 2", description="Zodiac Transit Ring Color 2")
 64    zodiac_transit_ring_3: str = Field(title="Zodiac Transit Ring Color 3", description="Zodiac Transit Ring Color 3")
 65    houses_radix_line: str = Field(title="Houses Radix Line Color", description="Houses Radix Line Color")
 66    houses_transit_line: str = Field(title="Houses Transit Line Color", description="Houses Transit Line Color")
 67
 68    # Deprecated: Not used anymore
 69    lunar_phase_0: str = Field(title="Lunar Phase Color 0", description="Lunar Phase Color 0")
 70    lunar_phase_1: str = Field(title="Lunar Phase Color 1", description="Lunar Phase Color 1")
 71
 72
 73# Aspect Settings
 74class KerykeionSettingsAspectModel(SubscriptableBaseModel):
 75    """
 76    Defines the model for an aspect.
 77    """
 78
 79    degree: int = Field(title="Aspect Degrees", description="The degree of the aspect")
 80    name: str = Field(title="Aspect Name", description="The name of the aspect")
 81    color: str = Field(title="Aspect Color", description="The color of the aspect")
 82    orb: Optional[int] = Field(title="Aspect Orb", description="The orb of the aspect", default=None)
 83
 84# Language Settings
 85class KerykeionLanguageCelestialPointModel(SubscriptableBaseModel):
 86    """
 87    This class is used to define the labels, show in the chart, for the celestial points.
 88    It is used to translate the celestial points in the language of the chart.
 89    """
 90
 91    Sun: str = Field(title="Sun", description="The name of the Sun in the chart, in the language")
 92    Moon: str = Field(title="Moon", description="The name of the Moon in the chart, in the language")
 93    Mercury: str = Field(title="Mercury", description="The name of Mercury in the chart, in the language")
 94    Venus: str = Field(title="Venus", description="The name of Venus in the chart, in the language")
 95    Mars: str = Field(title="Mars", description="The name of Mars in the chart, in the language")
 96    Jupiter: str = Field(title="Jupiter", description="The name of Jupiter in the chart, in the language")
 97    Saturn: str = Field(title="Saturn", description="The name of Saturn in the chart, in the language")
 98    Uranus: str = Field(title="Uranus", description="The name of Uranus in the chart, in the language")
 99    Neptune: str = Field(title="Neptune", description="The name of Neptune in the chart, in the language")
100    Pluto: str = Field(title="Pluto", description="The name of Pluto in the chart, in the language")
101    True_Node: str = Field(title="True Node", description="The name of True Node in the chart, in the language")
102    Mean_Node: str = Field(title="Mean Node", description="The name of Mean Node in the chart, in the language")
103    Chiron: str = Field(title="Chiron", description="The name of Chiron in the chart, in the language")
104    Ascendant: str = Field(title="Ascendant", description="The name of Ascendant in the chart, in the language")
105    Descendant: str = Field(title="Descendant", description="The name of Descendant in the chart, in the language")
106    Medium_Coeli: str = Field(title="Medium Coeli", description="The name of Medium Coeli in the chart, in the language")
107    Imum_Coeli: str = Field(title="Imum Coeli", description="The name of Imum Coeli in the chart, in the language")
108    Mean_Lilith: str = Field(title="Mean Lilith", description="The name of Mean Lilith in the chart, in the language")
109    True_South_Node: str = Field(title="True South Node", description="The name of True South Node in the chart, in the language")
110    Mean_South_Node: str = Field(title="Mean South Node", description="The name of Mean South Node in the chart, in the language")
111
112
113class KerykeionLanguageModel(SubscriptableBaseModel):
114    """
115    This model is used to store the language settings for the chart,
116    it's used to translate the celestial points and the other labels
117    """
118
119    info: str
120    cusp: str
121    longitude: str
122    latitude: str
123    north: str
124    east: str
125    south: str
126    west: str
127    fire: str
128    earth: str
129    air: str
130    water: str
131    and_word: str
132    transits: str
133    type: str
134    couple_aspects: str
135    transit_aspects: str
136    planets_and_house: str
137    transit_name: str
138    lunar_phase: str
139    day: str
140    celestial_points: KerykeionLanguageCelestialPointModel
141    composite_chart: str
142    midpoints: str
143    north_letter: str
144    east_letter: str
145    south_letter: str
146    west_letter: str
147    tropical: str
148    sidereal: str
149    zodiac: str
150    ayanamsa: str
151    apparent_geocentric: str
152    heliocentric: str
153    topocentric: str
154    true_geocentric: str
155    new_moon: str
156    waxing_crescent: str
157    first_quarter: str
158    waxing_gibbous: str
159    full_moon: str
160    waning_gibbous: str
161    last_quarter: str
162    waning_crescent: str
163    houses: str
164    houses_system_A: str
165    houses_system_B: str
166    houses_system_C: str
167    houses_system_D: str
168    houses_system_F: str
169    houses_system_H: str
170    houses_system_I: str
171    houses_system_i: str
172    houses_system_K: str
173    houses_system_L: str
174    houses_system_M: str
175    houses_system_N: str
176    houses_system_O: str
177    houses_system_P: str
178    houses_system_Q: str
179    houses_system_R: str
180    houses_system_S: str
181    houses_system_T: str
182    houses_system_U: str
183    houses_system_V: str
184    houses_system_W: str
185    houses_system_X: str
186    houses_system_Y: str
187    Natal: str
188    ExternalNatal: str
189    Synastry: str
190    Transit: str
191    Composite: str
192
193
194class KerykeionGeneralSettingsModel(SubscriptableBaseModel):
195    axes_orbit: int = Field(title="Axes Orbit", description="The orbit of the axes in the chart")
196
197
198# Settings Model
199class KerykeionSettingsModel(SubscriptableBaseModel):
200    """
201    This class is used to define the global settings for the Kerykeion.
202    """
203
204    chart_colors: KerykeionSettingsChartColorsModel = Field(title="Chart Colors", description="The colors of the chart")
205    celestial_points: List[KerykeionSettingsCelestialPointModel] = Field(title="Celestial Points", description="The list of the celestial points of the chart")
206    aspects: List[KerykeionSettingsAspectModel] = Field(title="Aspects", description="The list of the aspects of the chart")
207    language_settings: dict[str, KerykeionLanguageModel] = Field(title="Language Settings", description="The language settings of the chart")
208    general_settings: KerykeionGeneralSettingsModel = Field(title="General Settings", description="The general settings of the chart")