kerykeion.kr_types.settings_models

  1# -*- coding: utf-8 -*-
  2"""
  3    This is part of Kerykeion (C) 2024 Giacomo Battaglia
  4"""
  5
  6
  7from pydantic import Field
  8from typing import List
  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    is_active: bool = Field(title="Celestial Point is Active", description="Indicates if the celestial point is active in the chart")
 21    element_points: int = Field(title="Celestial Point Element Points", description="Element Points given to the celestial point")
 22    related_zodiac_signs: List[int] = Field(title="Celestial Point Related Zodiac Signs", description="Zodiac Signs related to the celestial point")
 23    label: str = Field(title="Celestial Point Label", description="The name of the celestial point in the chart, it can be different from the name")
 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    lunar_phase_0: str = Field(title="Lunar Phase Color 0", description="Lunar Phase Color 0")
 68    lunar_phase_1: str = Field(title="Lunar Phase Color 1", description="Lunar Phase Color 1")
 69    lunar_phase_2: str = Field(title="Lunar Phase Color 2", description="Lunar Phase Color 2")
 70
 71
 72# Aspect Settings
 73class KerykeionSettingsAspectModel(SubscriptableBaseModel):
 74    """
 75    Defines the model for an aspect.
 76    """
 77
 78    degree: int = Field(title="Aspect Degrees", description="The degree of the aspect")
 79    name: str = Field(title="Aspect Name", description="The name of the aspect")
 80    is_active: bool = Field(title="Aspect is Active", description="Is the aspect active?")
 81    visible_grid: bool = Field(title="Aspect Visible Grid", description="Is the aspect visible in the grid?")
 82    is_major: bool = Field(title="Aspect is Major", description="Is the aspect major?")
 83    is_minor: bool = Field(title="Aspect is Minor", description="Is the aspect minor?")
 84    orb: int = Field(title="Aspect Orb", description="The orb of the aspect")
 85    color: str = Field(title="Aspect Color", description="The color of the aspect")
 86
 87
 88# Language Settings
 89class KerykeionLanguageCelestialPointModel(SubscriptableBaseModel):
 90    """
 91    This class is used to define the labels, show in the chart, for the celestial points.
 92    It is used to translate the celestial points in the language of the chart.
 93    """
 94
 95    Sun: str = Field(title="Sun", description="The name of the Sun in the chart, in the language")
 96    Moon: str = Field(title="Moon", description="The name of the Moon in the chart, in the language")
 97    Mercury: str = Field(title="Mercury", description="The name of Mercury in the chart, in the language")
 98    Venus: str = Field(title="Venus", description="The name of Venus in the chart, in the language")
 99    Mars: str = Field(title="Mars", description="The name of Mars in the chart, in the language")
100    Jupiter: str = Field(title="Jupiter", description="The name of Jupiter in the chart, in the language")
101    Saturn: str = Field(title="Saturn", description="The name of Saturn in the chart, in the language")
102    Uranus: str = Field(title="Uranus", description="The name of Uranus in the chart, in the language")
103    Neptune: str = Field(title="Neptune", description="The name of Neptune in the chart, in the language")
104    Pluto: str = Field(title="Pluto", description="The name of Pluto in the chart, in the language")
105    True_Node: str = Field(title="True Node", description="The name of True Node in the chart, in the language")
106    Mean_Node: str = Field(title="Mean Node", description="The name of Mean Node in the chart, in the language")
107    Chiron: str = Field(title="Chiron", description="The name of Chiron in the chart, in the language")
108    Asc: str = Field(title="Ascendant", description="The name of Ascendant in the chart, in the language")
109    Mc: str = Field(title="Medium Coeli", description="The name of Medium Coeli in the chart, in the language")
110    Dsc: str = Field(title="Descendant", description="The name of Descendant in the chart, in the language")
111    Ic: str = Field(title="Imum Coeli", description="The name of Imum Coeli in the chart, in the language")
112
113
114class KerykeionLanguageModel(SubscriptableBaseModel):
115    """
116    This model is used to store the language settings for the chart,
117    it's used to translate the celestial points and the other labels
118    """
119
120    info: str = Field(title="Info", description="The name of the Info label in the chart, in the language")
121    cusp: str = Field(title="Cusp", description="The name of the Cusp label in the chart, in the language")
122    longitude: str = Field(title="Longitude", description="The name of the Longitude label in the chart, in the language")
123    latitude: str = Field(title="Latitude", description="The name of the Latitude label in the chart, in the language")
124    north: str = Field(title="North", description="The name of the North label in the chart, in the language")
125    east: str = Field(title="East", description="The name of the East label in the chart, in the language")
126    south: str = Field(title="South", description="The name of the South label in the chart, in the language")
127    west: str = Field(title="West", description="The name of the West label in the chart, in the language")
128    fire: str = Field(title="Fire", description="The name of the Fire label in the chart, in the language")
129    earth: str = Field(title="Earth", description="The name of the Earth label in the chart, in the language")
130    air: str = Field(title="Air", description="The name of the Air label in the chart, in the language")
131    water: str = Field(title="Water", description="The name of the Water label in the chart, in the language")
132    and_word: str = Field(title="And", description="The name of the And word in the chart, in the language")
133    transits: str = Field(title="Transits", description="The name of the Transits label in the chart, in the language")
134    type: str = Field(title="Type", description="The name of the Type label in the chart, in the language")
135    aspects: str = Field(title="Aspects", description="The name of the Aspects label in the chart, in the language")
136    planets_and_house: str = Field(title="Planets and Houses", description="The name of the Planets and Houses label in the chart, in the language")
137    transit_name: str = Field(title="Transit Name", description="The name of the Transit Name label in the chart, in the language")
138    lunar_phase: str = Field(title="Lunar Phase", description="The name of the Lunar Phase label in the chart, in the language")
139    day: str = Field(title="Day", description="The name of the Day label in the chart, in the language")
140    celestial_points: KerykeionLanguageCelestialPointModel
141
142
143class KerykeionGeneralSettingsModel(SubscriptableBaseModel):
144    axes_orbit: int = Field(title="Axes Orbit", description="The orbit of the axes in the chart")
145    planet_in_zodiac_extra_points: int = Field(title="Planet in Zodiac Extra Points", description="The extra points of the planet in the zodiac")
146    language: str = Field(title="Language", description="The language of the chart")
147
148class KerykeionChartSettingsModel(SubscriptableBaseModel):
149    basic_chart_viewBox: str = Field(title="Basic Chart ViewBox", description="The viewbox of the basic chart")
150    wide_chart_viewBox: str = Field(title="Wide Chart ViewBox", description="The viewbox of the wide chart")
151
152# Settings Model
153class KerykeionSettingsModel(SubscriptableBaseModel):
154    """
155    This class is used to define the global settings for the Kerykeion.
156    """
157
158    chart_colors: KerykeionSettingsChartColorsModel = Field(title="Chart Colors", description="The colors of the chart")
159    celestial_points: List[KerykeionSettingsCelestialPointModel] = Field(title="Celestial Points", description="The list of the celestial points of the chart")
160    aspects: List[KerykeionSettingsAspectModel] = Field(title="Aspects", description="The list of the aspects of the chart")
161    language_settings: dict[str, KerykeionLanguageModel] = Field(title="Language Settings", description="The language settings of the chart")
162    general_settings: KerykeionGeneralSettingsModel = Field(title="General Settings", description="The general settings of the chart")
163    chart_settings: KerykeionChartSettingsModel = Field(title="Chart Settings", description="The chart settings of the chart")