kerykeion 3.1.1__py3-none-any.whl → 5.1.9__py3-none-any.whl

kerykeion/__init__.py

@@ -1,146 +1,63 @@
+# -*- coding: utf-8 -*-
 """
-    This is part of Kerykeion (C) 2022 Giacomo Battaglia
-
-    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 composite chart or a transit chart.
-
-    Here some examples:
-
-    ```python
-
-    # Import the main class for creating a kerykeion instance:
-    >>> from kerykeion import KrInstance
-
-    # Create a kerykeion instance:
-    # Args: Name, year, month, day, hour, minuts, city, nation(optional)
-    >>> kanye = KrInstance("Kanye", 1977, 6, 8, 8, 45, "Atlanta")
-
-    # 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}
-
-    # 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': '♋️'}
-
-    # Get element of the moon sign:
-    >>> kanye.moon.get("element")
-    'Water'
-
-    ```
-
-    ## Generate a SVG of the birthchart:
-
-    ```python
-    >>> from kerykeion import KrInstance, MakeSvgInstance
-
-    >>> first = KrInstance("Jack", 1990, 6, 15, 15, 15, "Roma")
-    >>> second = KrInstance("Jane", 1991, 10, 25, 21, 00, "Roma")
-
-    # Set the type, it can be Natal, Composite or Transit
-
-    >>> name = MakeSvgInstance(first, chart_type="Composite", 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
-
-    ```
-
-    ![alt text](http://centuryboy.altervista.org/JackComposite_Chart.svg)
-
-
-    # Example of a possible text output with information:
-
-    ```python
-    >>> from kerykeion import print_all_data, KrInstance
-
-    >>> kanye = KrInstance("Kanye", 1977, 6, 8, 8, 45, "Atlanta")
-
-    >>> print_all_data(kanye)
-    NAME: Kanye
-    PLANET     POSITION
-
-    Sun:       Gem 17.599 in 12th House
-    Moon:      Pis 16.425 in 9th House
-    Mercury:   Tau 26.286 in 11th House
-    Venus:     Tau 2.032 in 10th House
-    Mars:      Tau 1.79 in 10th House
-    Jupiter:   Gem 14.607 in 11th House
-    Saturn:    Leo 12.799 in 2nd House
-    Uranus:    Sco 8.273 in 4th House
-    Neptune:   Sag 14.693 in 5th House
-    Pluto:     Lib 11.446 in 4th House
-
-    PLACIDUS HAUSES
-    House Cusp 1:     Can  17.996
-    House Cusp 2:     Leo  9.506
-    House Cusp 3:     Vir  4.022
-    House Cusp 4:     Lib  3.977
-    House Cusp 5:     Sco  9.393
-    House Cusp 6:     Sag  15.681
-    House Cusp 7:     Cap  17.996
-    House Cusp 8:     Aqu  9.506
-    House Cusp 9:     Pis  4.022
-    House Cusp 10:    Ari  3.977
-    House Cusp 11:    Tau  9.393
-    House Cusp 12:    Gem  15.681
-
-    ```
-
-    ## Other exeples of possibles usecase
-
-    ```python
-    # Get all aspects between two persons:
-
-    >>> from kerykeion import CompositeAspects, KrInstance
-    >>> first = KrInstance("Jack", 1990, 6, 15, 15, 15, "Roma")
-    >>> second = KrInstance("Jane", 1991, 10, 25, 21, 00, "Roma")
-
-    >>> name = CompositeAspects(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://g-battaglia.github.io/kerykeion).
-
-    Sooner or later I'll try to write an extensive documentation.
-
-    ## Installation
-
-    Kerykeion is a Python 3 package, make sure you have Python 3 installed on your system.
-
-    ## Development
-
-    You can clone this repository or download a zip file using the right side buttons.
-
-    ## Contributing
-
-    Feel free to contribute to the code!
+This is part of Kerykeion (C) 2025 Giacomo Battaglia
 
+.. include:: ../README.md
 """
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 
 # Local
-from .main import KrInstance
-from .print_all_data import print_all_data
-from .charts.charts_svg import MakeSvgInstance
-from .types import *
-from .relationship_score import RelationshipScore
-from .aspects import NatalAspects, CompositeAspects
+from .aspects import AspectsFactory
+from .astrological_subject_factory import AstrologicalSubjectFactory
+from .chart_data_factory import ChartDataFactory
+from .schemas import KerykeionException
+from .schemas.kr_models import (
+    ChartDataModel,
+    SingleChartDataModel,
+    DualChartDataModel,
+    ElementDistributionModel,
+    QualityDistributionModel,
+    HouseComparisonModel,
+)
+from .charts.chart_drawer import ChartDrawer
+from .composite_subject_factory import CompositeSubjectFactory
+from .ephemeris_data_factory import EphemerisDataFactory
+from .house_comparison.house_comparison_factory import HouseComparisonFactory
+from .planetary_return_factory import PlanetaryReturnFactory, PlanetReturnModel
+from .relationship_score_factory import RelationshipScoreFactory
+from .report import ReportGenerator
+from .settings import KerykeionSettingsModel
+from .transits_time_range_factory import TransitsTimeRangeFactory
+from .backword import (
+    AstrologicalSubject,  # Legacy wrapper
+    KerykeionChartSVG,    # Legacy wrapper
+    NatalAspects,         # Legacy wrapper
+    SynastryAspects,      # Legacy wrapper
+)
+
+__all__ = [
+    "AspectsFactory",
+    "AstrologicalSubjectFactory",
+    "ChartDataFactory",
+    "ChartDataModel",
+    "SingleChartDataModel",
+    "DualChartDataModel",
+    "ElementDistributionModel",
+    "QualityDistributionModel",
+    "ChartDrawer",
+    "CompositeSubjectFactory",
+    "EphemerisDataFactory",
+    "HouseComparisonFactory",
+    "HouseComparisonModel",
+    "KerykeionException",
+    "PlanetaryReturnFactory",
+    "PlanetReturnModel",
+    "RelationshipScoreFactory",
+    "ReportGenerator",
+    "KerykeionSettingsModel",
+    "TransitsTimeRangeFactory",
+    # Legacy (v4) exported names for backward compatibility
+    "AstrologicalSubject",
+    "KerykeionChartSVG",
+    "NatalAspects",
+    "SynastryAspects",
+]

kerykeion/aspects/__init__.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+"""
+This is part of Kerykeion (C) 2025 Giacomo Battaglia
+
+The aspects module contains the classes and functions for calculating
+ aspects between planets and points in a chart.
+"""
+
+
+from .aspects_factory import AspectsFactory
+
+__all__ = [
+    "AspectsFactory",
+]