kerykeion 5.0.0b4__tar.gz → 5.0.0b5__tar.gz

{kerykeion-5.0.0b4 → kerykeion-5.0.0b5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kerykeion
-Version: 5.0.0b4
+Version: 5.0.0b5
 Summary: A Python library for astrological calculations, including natal charts, houses, planetary aspects, and SVG chart generation.
 Project-URL: Homepage, https://www.kerykeion.net/
 Project-URL: Repository, https://github.com/g-battaglia/kerykeion
@@ -926,16 +926,42 @@ Module structure has been completely reorganized:
 ```python
 from kerykeion import AstrologicalSubject, KerykeionChartSVG
 from kerykeion.kr_types import KerykeionException
+from kerykeion.kr_types.kr_literals import Planet, AxialCusps
 ```
 
 **New imports (v5):**
 
 ```python
 from kerykeion import AstrologicalSubjectFactory, ChartDataFactory, ChartDrawer
-from kerykeion.schemas.kerykeion_exception import KerykeionException
+from kerykeion.schemas import KerykeionException
+from kerykeion.schemas.kr_literals import AstrologicalPoint
 ```
 
-#### 3. Lunar Nodes Naming
+**Backward compatibility (v5 only, removed in v6.0):**
+
+```python
+# Old kr_types imports still work with deprecation warnings
+from kerykeion.kr_types import Planet, AxialCusps  # Shows warning
+from kerykeion.schemas import Planet, AxialCusps    # Works, no warning
+```
+
+#### 3. Type Aliases Unified
+
+**Old (v4):** `Planet` and `AxialCusps` were separate types  
+**New (v5):** Unified as `AstrologicalPoint`
+
+```python
+# v4
+from kerykeion.kr_types.kr_literals import Planet, AxialCusps
+
+# v5 (recommended)
+from kerykeion.schemas.kr_literals import AstrologicalPoint
+
+# v5 (transition, uses aliases)
+from kerykeion.schemas import Planet, AxialCusps  # Still available
+```
+
+#### 4. Lunar Nodes Naming
 
 All lunar node fields have been renamed for clarity:
 
@@ -956,11 +982,11 @@ print(subject.mean_node)
 print(subject.mean_north_lunar_node)
 ```
 
-#### 4. Axis Orb Filtering
+#### 5. Axis Orb Filtering
 
 Modern default orbs now treat chart axes (ASC, MC, DSC, IC) exactly like planets. If you prefer a traditional, constrained approach, every public aspect factory exposes the keyword-only `axis_orb_limit` parameter so you can set a dedicated threshold when needed.
 
-#### 5. Chart Generation Changes
+#### 6. Chart Generation Changes
 
 The two-step process (data + rendering) is now required:
 
@@ -979,7 +1005,7 @@ drawer = ChartDrawer(chart_data=chart_data)
 drawer.save_svg()
 ```
 
-#### 5. Aspects API Changes
+#### 7. Aspects API Changes
 
 Aspects are now calculated through the factory:
 

{kerykeion-5.0.0b4 → kerykeion-5.0.0b5}/README.md

@@ -886,16 +886,42 @@ Module structure has been completely reorganized:
 ```python
 from kerykeion import AstrologicalSubject, KerykeionChartSVG
 from kerykeion.kr_types import KerykeionException
+from kerykeion.kr_types.kr_literals import Planet, AxialCusps
 ```
 
 **New imports (v5):**
 
 ```python
 from kerykeion import AstrologicalSubjectFactory, ChartDataFactory, ChartDrawer
-from kerykeion.schemas.kerykeion_exception import KerykeionException
+from kerykeion.schemas import KerykeionException
+from kerykeion.schemas.kr_literals import AstrologicalPoint
 ```
 
-#### 3. Lunar Nodes Naming
+**Backward compatibility (v5 only, removed in v6.0):**
+
+```python
+# Old kr_types imports still work with deprecation warnings
+from kerykeion.kr_types import Planet, AxialCusps  # Shows warning
+from kerykeion.schemas import Planet, AxialCusps    # Works, no warning
+```
+
+#### 3. Type Aliases Unified
+
+**Old (v4):** `Planet` and `AxialCusps` were separate types  
+**New (v5):** Unified as `AstrologicalPoint`
+
+```python
+# v4
+from kerykeion.kr_types.kr_literals import Planet, AxialCusps
+
+# v5 (recommended)
+from kerykeion.schemas.kr_literals import AstrologicalPoint
+
+# v5 (transition, uses aliases)
+from kerykeion.schemas import Planet, AxialCusps  # Still available
+```
+
+#### 4. Lunar Nodes Naming
 
 All lunar node fields have been renamed for clarity:
 
@@ -916,11 +942,11 @@ print(subject.mean_node)
 print(subject.mean_north_lunar_node)
 ```
 
-#### 4. Axis Orb Filtering
+#### 5. Axis Orb Filtering
 
 Modern default orbs now treat chart axes (ASC, MC, DSC, IC) exactly like planets. If you prefer a traditional, constrained approach, every public aspect factory exposes the keyword-only `axis_orb_limit` parameter so you can set a dedicated threshold when needed.
 
-#### 5. Chart Generation Changes
+#### 6. Chart Generation Changes
 
 The two-step process (data + rendering) is now required:
 
@@ -939,7 +965,7 @@ drawer = ChartDrawer(chart_data=chart_data)
 drawer.save_svg()
 ```
 
-#### 5. Aspects API Changes
+#### 7. Aspects API Changes
 
 Aspects are now calculated through the factory:
 

kerykeion-5.0.0b5/kerykeion/kr_types/__init__.py

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+"""
+Backward compatibility module for Kerykeion v4.x imports.
+
+DEPRECATED: This module will be removed in Kerykeion v6.0.
+Please update your imports:
+    OLD: from kerykeion.kr_types import ...
+    NEW: from kerykeion.schemas import ...
+"""
+import warnings
+
+# Issue deprecation warning when this module is imported
+warnings.warn(
+    "The 'kerykeion.kr_types' module is deprecated and will be removed in v6.0. "
+    "Please update your imports to use 'kerykeion.schemas' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+# Re-export everything from schemas for backward compatibility
+from kerykeion.schemas import *  # noqa: F401, F403
+from kerykeion.schemas.kerykeion_exception import *  # noqa: F401, F403
+from kerykeion.schemas.kr_literals import *  # noqa: F401, F403
+from kerykeion.schemas.kr_models import *  # noqa: F401, F403
+from kerykeion.schemas.settings_models import *  # noqa: F401, F403
+from kerykeion.schemas.chart_template_model import *  # noqa: F401, F403
+
+__all__ = [
+    # Re-export from schemas
+    "KerykeionException",
+    # kr_literals
+    "ZodiacType",
+    "Sign",
+    "SignNumbers",
+    "AspectMovementType",
+    "Houses",
+    "HouseNumbers",
+    "AstrologicalPoint",
+    "Element",
+    "Quality",
+    "ChartType",
+    "PointType",
+    "LunarPhaseEmoji",
+    "LunarPhaseName",
+    "SiderealMode",
+    "HousesSystemIdentifier",
+    "PerspectiveType",
+    "SignsEmoji",
+    "KerykeionChartTheme",
+    "KerykeionChartLanguage",
+    "RelationshipScoreDescription",
+    "CompositeChartType",
+    "AspectName",
+    # kr_models
+    "AstrologicalSubjectModel",
+    "CompositeSubjectModel",
+    "KerykeionPointModel",
+    "AspectModel",
+    "ActiveAspect",
+    "SingleChartAspectsModel",
+    "DualChartAspectsModel",
+    "ElementDistributionModel",
+    "QualityDistributionModel",
+    "SingleChartDataModel",
+    "DualChartDataModel",
+    # settings_models
+    "KerykeionSettingsModel",
+    # chart_template_model
+    "ChartTemplateModel",
+]

kerykeion-5.0.0b5/kerykeion/kr_types/chart_template_model.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+"""
+Backward compatibility module for chart_template_model.
+
+DEPRECATED: This module will be removed in Kerykeion v6.0.
+Please update your imports:
+    OLD: from kerykeion.kr_types.chart_template_model import ...
+    NEW: from kerykeion.schemas.chart_template_model import ...
+"""
+import warnings
+
+warnings.warn(
+    "The 'kerykeion.kr_types.chart_template_model' module is deprecated and will be removed in v6.0. "
+    "Please update your imports to use 'kerykeion.schemas.chart_template_model' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+# Re-export everything from schemas.chart_template_model for backward compatibility
+from kerykeion.schemas.chart_template_model import *  # noqa: F401, F403

kerykeion-5.0.0b5/kerykeion/kr_types/kerykeion_exception.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+"""
+Backward compatibility module for kerykeion_exception.
+
+DEPRECATED: This module will be removed in Kerykeion v6.0.
+Please update your imports:
+    OLD: from kerykeion.kr_types.kerykeion_exception import ...
+    NEW: from kerykeion.schemas.kerykeion_exception import ...
+"""
+import warnings
+
+warnings.warn(
+    "The 'kerykeion.kr_types.kerykeion_exception' module is deprecated and will be removed in v6.0. "
+    "Please update your imports to use 'kerykeion.schemas.kerykeion_exception' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+# Re-export everything from schemas.kerykeion_exception for backward compatibility
+from kerykeion.schemas.kerykeion_exception import *  # noqa: F401, F403

kerykeion-5.0.0b5/kerykeion/kr_types/kr_literals.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+"""
+Backward compatibility module for kr_literals.
+
+DEPRECATED: This module will be removed in Kerykeion v6.0.
+Please update your imports:
+    OLD: from kerykeion.kr_types.kr_literals import ...
+    NEW: from kerykeion.schemas.kr_literals import ...
+"""
+import warnings
+
+warnings.warn(
+    "The 'kerykeion.kr_types.kr_literals' module is deprecated and will be removed in v6.0. "
+    "Please update your imports to use 'kerykeion.schemas.kr_literals' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+# Re-export everything from schemas.kr_literals for backward compatibility
+from kerykeion.schemas.kr_literals import *  # noqa: F401, F403

kerykeion-5.0.0b5/kerykeion/kr_types/kr_models.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+"""
+Backward compatibility module for kr_models.
+
+DEPRECATED: This module will be removed in Kerykeion v6.0.
+Please update your imports:
+    OLD: from kerykeion.kr_types.kr_models import ...
+    NEW: from kerykeion.schemas.kr_models import ...
+"""
+import warnings
+
+warnings.warn(
+    "The 'kerykeion.kr_types.kr_models' module is deprecated and will be removed in v6.0. "
+    "Please update your imports to use 'kerykeion.schemas.kr_models' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+# Re-export everything from schemas.kr_models for backward compatibility
+from kerykeion.schemas.kr_models import *  # noqa: F401, F403

kerykeion-5.0.0b5/kerykeion/kr_types/settings_models.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+"""
+Backward compatibility module for settings_models.
+
+DEPRECATED: This module will be removed in Kerykeion v6.0.
+Please update your imports:
+    OLD: from kerykeion.kr_types.settings_models import ...
+    NEW: from kerykeion.schemas.settings_models import ...
+"""
+import warnings
+
+warnings.warn(
+    "The 'kerykeion.kr_types.settings_models' module is deprecated and will be removed in v6.0. "
+    "Please update your imports to use 'kerykeion.schemas.settings_models' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+# Re-export everything from schemas.settings_models for backward compatibility
+from kerykeion.schemas.settings_models import *  # noqa: F401, F403

{kerykeion-5.0.0b4 → kerykeion-5.0.0b5}/kerykeion/schemas/__init__.py

@@ -27,6 +27,9 @@ from .kr_literals import (
     RelationshipScoreDescription,
     CompositeChartType,
     AspectName,
+    # Deprecated aliases
+    Planet,
+    AxialCusps,
 )
 from .kr_models import (
     SubscriptableBaseModel,
@@ -80,6 +83,10 @@ __all__ = [
     "CompositeChartType",
     "AspectName",
 
+    # Deprecated aliases (for v4.x compatibility, will be removed in v6.0)
+    "Planet",
+    "AxialCusps",
+
     # Main Model Classes (from kr_models)
     "SubscriptableBaseModel",
     "LunarPhaseModel",

{kerykeion-5.0.0b4 → kerykeion-5.0.0b5}/kerykeion/schemas/kr_literals.py

@@ -168,3 +168,14 @@ AspectName = Literal[
 
 ReturnType = Literal["Lunar", "Solar"]
 """Literal type for Return Types"""
+
+
+# ---------------------------------------------------------------------------
+# Deprecated aliases for backward compatibility with Kerykeion v4.x
+# ---------------------------------------------------------------------------
+# These will be removed in v6.0 - migrate to AstrologicalPoint
+Planet = AstrologicalPoint
+"""DEPRECATED: Use AstrologicalPoint instead. This alias will be removed in v6.0."""
+
+AxialCusps = AstrologicalPoint
+"""DEPRECATED: Use AstrologicalPoint instead. This alias will be removed in v6.0."""

{kerykeion-5.0.0b4 → kerykeion-5.0.0b5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kerykeion"
-version = "5.0.0b4"
+version = "5.0.0b5"
 authors = [
     { name = "Giacomo Battaglia", email = "kerykeion.astrology@gmail.com" }
 ]

{kerykeion-5.0.0b4 → kerykeion-5.0.0b5}/release_notes/v5.0.0.md

@@ -35,8 +35,10 @@
 
 ## Compatibility & migration from v4
 - Import directly from the package root (`from kerykeion import AstrologicalSubjectFactory, ChartDataFactory, ChartDrawer, ...`).
-- `kerykeion.backword` provides deprecated wrappers (`AstrologicalSubject`, `KerykeionChartSVG`, `SynastryAspects`) so existing code keeps running while pointing to the new APIs.
-- `kr_types` has been replaced by `kerykeion.schemas`; update exceptions, literals, and model imports accordingly.
+- `kerykeion.backword` provides deprecated wrappers (`AstrologicalSubject`, `KerykeionChartSVG`, `NatalAspects`, `SynastryAspects`) so existing code keeps running while pointing to the new APIs.
+- `kr_types` module path still works but shows deprecation warnings; update to `kerykeion.schemas`.
+- Type aliases `Planet` and `AxialCusps` unified as `AstrologicalPoint`; legacy aliases available in v5 without warnings when imported from `schemas`.
+- Backward compatibility layer (`kr_types` module and legacy wrappers) will be **removed in v6.0**.
 - Relationship scoring now lives in `RelationshipScoreFactory` and the models returned by `ChartDataFactory`.
 - Regeneration scripts (`scripts/regenerate_*`) realign fixtures and custom SVG assets with the new pipeline.
 

kerykeion-5.0.0b5/tests/test_backward_compatibility.py

@@ -0,0 +1,177 @@
+"""
+Tests for backward compatibility aliases (kr_types module and deprecated type aliases).
+
+This test suite verifies that Kerykeion v5 maintains compatibility with v4 imports,
+while issuing appropriate deprecation warnings.
+"""
+import warnings
+import pytest
+
+
+class TestKrTypesModuleCompatibility:
+    """Test that kr_types module exists and re-exports schemas."""
+
+    def test_kr_types_import_with_warning(self):
+        """Test that importing kr_types triggers deprecation warning."""
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always", DeprecationWarning)
+            
+            # Import should work but trigger warning
+            from kerykeion import kr_types  # noqa: F401
+            
+            # Filter for kr_types specific deprecation warnings
+            kr_types_warnings = [
+                warning for warning in w 
+                if issubclass(warning.category, DeprecationWarning) 
+                and "kr_types" in str(warning.message)
+            ]
+            assert len(kr_types_warnings) >= 1
+            assert "v6.0" in str(kr_types_warnings[0].message)
+
+    def test_kr_types_planet_alias(self):
+        """Test that Planet alias is available from kr_types."""
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            
+            from kerykeion.kr_types import Planet, AstrologicalPoint
+            
+            # Planet should be an alias for AstrologicalPoint
+            assert Planet == AstrologicalPoint
+
+    def test_kr_types_axial_cusps_alias(self):
+        """Test that AxialCusps alias is available from kr_types."""
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            
+            from kerykeion.kr_types import AxialCusps, AstrologicalPoint
+            
+            # AxialCusps should be an alias for AstrologicalPoint
+            assert AxialCusps == AstrologicalPoint
+
+    def test_kr_types_kr_literals_submodule(self):
+        """Test that kr_types.kr_literals works as a compatibility shim."""
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always", DeprecationWarning)
+            
+            from kerykeion.kr_types.kr_literals import Planet, AxialCusps
+            
+            # Should trigger deprecation warning
+            deprecation_warnings = [warning for warning in w if issubclass(warning.category, DeprecationWarning)]
+            assert any("kr_types.kr_literals" in str(dw.message) for dw in deprecation_warnings)
+            
+            # But imports should still work
+            assert Planet is not None
+            assert AxialCusps is not None
+
+    def test_kr_types_kr_models_submodule(self):
+        """Test that kr_types.kr_models works as a compatibility shim."""
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always", DeprecationWarning)
+            
+            from kerykeion.kr_types.kr_models import AstrologicalSubjectModel
+            
+            # Should trigger deprecation warning
+            deprecation_warnings = [warning for warning in w if issubclass(warning.category, DeprecationWarning)]
+            assert any("kr_types.kr_models" in str(dw.message) for dw in deprecation_warnings)
+            
+            # But imports should still work
+            assert AstrologicalSubjectModel is not None
+
+
+class TestDeprecatedAliasesInSchemas:
+    """Test that deprecated aliases are available in new schemas module."""
+
+    def test_planet_alias_in_schemas(self):
+        """Test that Planet alias exists in schemas module."""
+        from kerykeion.schemas import Planet, AstrologicalPoint
+        
+        # Planet should be an alias for AstrologicalPoint
+        assert Planet == AstrologicalPoint
+
+    def test_axial_cusps_alias_in_schemas(self):
+        """Test that AxialCusps alias exists in schemas module."""
+        from kerykeion.schemas import AxialCusps, AstrologicalPoint
+        
+        # AxialCusps should be an alias for AstrologicalPoint
+        assert AxialCusps == AstrologicalPoint
+
+    def test_planet_alias_in_kr_literals(self):
+        """Test that Planet alias exists in schemas.kr_literals."""
+        from kerykeion.schemas.kr_literals import Planet, AstrologicalPoint
+        
+        assert Planet == AstrologicalPoint
+
+    def test_axial_cusps_alias_in_kr_literals(self):
+        """Test that AxialCusps alias exists in schemas.kr_literals."""
+        from kerykeion.schemas.kr_literals import AxialCusps, AstrologicalPoint
+        
+        assert AxialCusps == AstrologicalPoint
+
+
+class TestMigrationPathExamples:
+    """Document migration paths for common v4 usage patterns."""
+
+    def test_v4_import_pattern_1(self):
+        """
+        V4 Pattern: from kerykeion.kr_types import Planet
+        V5 Pattern: from kerykeion.schemas import AstrologicalPoint
+        
+        Compatibility: from kerykeion.schemas import Planet (with alias)
+        """
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            
+            # Old way (still works via kr_types)
+            from kerykeion.kr_types import Planet as PlanetOld
+            
+            # New way (recommended)
+            from kerykeion.schemas import AstrologicalPoint
+            
+            # Transition way (works, no warning)
+            from kerykeion.schemas import Planet as PlanetAlias
+            
+            assert PlanetOld == AstrologicalPoint
+            assert PlanetAlias == AstrologicalPoint
+
+    def test_v4_import_pattern_2(self):
+        """
+        V4 Pattern: from kerykeion.kr_types.kr_literals import Planet, AxialCusps
+        V5 Pattern: from kerykeion.schemas.kr_literals import AstrologicalPoint
+        
+        Compatibility: from kerykeion.schemas.kr_literals import Planet, AxialCusps
+        """
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            
+            # Old way (still works via kr_types, with deprecation)
+            from kerykeion.kr_types.kr_literals import Planet as POld, AxialCusps as ACOld
+            
+            # New way (recommended)
+            from kerykeion.schemas.kr_literals import AstrologicalPoint
+            
+            # Transition way (works, no warning)
+            from kerykeion.schemas.kr_literals import Planet as PNew, AxialCusps as ACNew
+            
+            assert POld == AstrologicalPoint
+            assert ACOld == AstrologicalPoint
+            assert PNew == AstrologicalPoint
+            assert ACNew == AstrologicalPoint
+
+    def test_v4_import_pattern_3(self):
+        """
+        V4 Pattern: from kerykeion.kr_types.kr_models import AstrologicalSubjectModel
+        V5 Pattern: from kerykeion.schemas.kr_models import AstrologicalSubjectModel
+        
+        No alias needed here, just path change.
+        """
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", DeprecationWarning)
+            
+            # Old way (still works via kr_types, with deprecation)
+            from kerykeion.kr_types.kr_models import AstrologicalSubjectModel as ASMOld
+            
+            # New way (recommended, no warning)
+            from kerykeion.schemas.kr_models import AstrologicalSubjectModel as ASMNew
+            
+            # Should be the same class
+            assert ASMOld is ASMNew