kerykeion 5.0.0a7__tar.gz → 5.0.0a8__tar.gz

kerykeion-5.0.0a8/.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: kerykeion
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

kerykeion-5.0.0a8/.gitignore

@@ -0,0 +1,54 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Folders #
+###########
+
+__pycache__
+venv
+.vscode
+mecuriusastro.egg-info
+kerykeion.egg-info
+build/
+dist/
+.geonames_cache
+.kerykeion
+kr_venv
+request_cache
+Pipfile
+.mypy_cache

kerykeion-5.0.0a8/CHANGELOG.md

@@ -0,0 +1,119 @@
+# Changelog
+
+## 4.2.0
+
+_Released 08/01/2023_
+
+**Bugfixes:**
+
+- fixing float-int presidence bug
+
+**Dependency Updates:**
+
+- Updated `pydantic` to `2.5`
+
+**Credits:**
+
+- Thanks to @jackklika for the PR, more details [here](https://github.com/g-battaglia/kerykeion/pull/98)
+
+## 4.4.0
+
+_Released 05/03/2024_
+
+**New Features:**
+
+Allow UTC datetime to be passed in the constructor as an alternative to year, month, day, hour, minute and timezone (#108)
+
+**Credits:**
+
+- Thanks to @jackklika for the PR, more details [here](https://github.com/g-battaglia/kerykeion/pull/108)
+
+## 4.5.0
+
+- _AstrologicalSubject_ Is now possible to disable Chiron calculation with `disable_chiron=True` for better compatibility with older dates.
+- New module enums added for better type hinting, still to be expanded and really used.
+
+## 4.5.1
+
+- Fixed | bug for compatibility with Python 3.9
+
+## 4.6.0
+
+- Now the `lunar_phase` contains also the `lunar_phase_name` property, which is a string representation of the phase.
+- Minor general cleanup and refactoring of the codebase.
+
+## 4.7.0
+
+A lot of refactoring and clean up.
+`Fix`: In the old version the 4 last planets of the Transit chart were always removed, now we check if those are Axes and then
+remove them.
+
+## 4.8.0
+
+Added the optional `minify` argument to makeTemplate in the charts module.
+
+## 4.10.0
+
+- Added the `sidereal_mode` argument to the `AstrologicalChart` class to allow differet Ayanamsa calculation methods.
+
+## 4.11.0
+
+- Added different House Systems to the `AstrologicalChart` class.
+
+## 4.14.0
+
+- Added Lilith to astrological calculations and chart rendering.
+- Deprecated `disable_chiron` in favor of `disable_chiron_and_lilith` with deprecation warning.
+- Updated configuration in `kr.config.json` for Lilith settings.
+
+## 4.16.0
+
+- Added themed astrological charts (`theme` parameter), including Classic, Dark, Dark High Contrast, and Light themes.
+- Added wheel-only charts and separate aspect table SVG.
+- Added grid view for aspect tables in synastry and transit charts.
+
+## 4.17.0
+
+- Added `chart_language` parameter to set chart language (EN, FR, PT, ES, TR, RU, IT, CN, DE).
+- Enhanced `get_settings` function to accept a dictionary or `KerykeionSettingsModel` instance.
+
+## 4.19.0
+
+- Added support for True and Mean Lunar Nodes (`true_node`, `true_south_node`, `mean_node`, `mean_south_node`).
+- Default activation of mean nodes; configurable activation of true nodes via `kr.config.json`.
+
+## 4.21.0
+
+- Customizable Geonames cache timeout (default extended from 24 hours to 30 days).
+
+**Credits:**
+
+- Thanks to @tomshaffner for the idea and implementation.
+
+## 4.22.0
+
+- Explicit calculation of Ascendant (AC), Descendant (DC), Midheaven (MC), and Imum Coeli (IC) axes.
+- Introduced `axial_cusps_names_list` parameter and replaced `check_if_between` with `is_point_between` utility.
+- Configuration updates for axes in `kr.config.json`.
+
+**Credits:**
+
+- Thanks to @fkostadinov for implementing these changes in PR #138.
+
+## 4.23.0
+
+- Added `active_points` parameter to `KerykeionChartSVG` for runtime specification of active planets and axial cusps.
+
+## 4.24.0
+
+- Added `active_aspects` parameter to `KerykeionChartSVG` for runtime specification of active aspects and orbs.
+
+## 4.25.0
+
+- Added composite charts feature: create composite subjects and charts using the midpoint method.
+
+## 4.26.0
+
+- Introduced `TransitsTimeRangeFactory` for calculating transit events across specified time ranges.
+- Added `get_ephemeris_data_as_astrological_subjects` method in `EphemerisDataFactory`.
+- Added `p*_owner` fields in aspect models for subject identification in `natal_aspects` and `synastry_aspects`.

kerykeion-5.0.0a8/DEVELOPMENT.md

@@ -0,0 +1,256 @@
+# 🛠️ Development Setup Guide
+
+Welcome to Kerykeion! This guide will help you set up your development environment to contribute to this astrology library.
+
+## 📋 Prerequisites
+
+Before you begin, ensure you have the following installed:
+
+- **Python 3.9 or higher** - Check with `python --version`
+- **Git** - For cloning the repository
+- **uv** - Ultra-fast Python package manager (replaces pip/poetry)
+
+### Installing uv
+
+If you don't have uv installed, follow the installation instructions at the official website:
+
+**👉 [https://docs.astral.sh/uv/getting-started/installation/](https://docs.astral.sh/uv/getting-started/installation/)**
+
+## 🚀 Quick Start
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/g-battaglia/kerykeion.git
+   cd kerykeion
+   ```
+
+2. **Install dependencies**
+   ```bash
+   # This creates a virtual environment and installs all dependencies
+   uv sync --dev
+   ```
+
+3. **Verify installation**
+   ```bash
+   # Test that kerykeion can be imported
+   uv run python -c "import kerykeion; print('✅ Setup successful!')"
+   ```
+
+## 🧪 Development Commands
+
+Kerykeion uses [poethepoet](https://github.com/nat-n/poethepoet) as a task runner. All tasks are defined in `pyproject.toml`.
+
+### Running Tests
+```bash
+# Run all tests
+uv run poe test
+
+# Run tests without output capture (useful for debugging)
+uv run poe test-no-capture
+
+# Run tests excluding chart generation tests
+uv run poe test-nocharts
+
+# Run specific test file
+uv run pytest tests/test_astrological_subject.py
+
+# Run tests with coverage
+uv run pytest --cov=kerykeion
+```
+
+### Code Quality
+```bash
+# Format code with Black
+uv run poe format
+
+# Format all code (including tests)
+uv run poe format:all
+
+# Type checking with MyPy
+uv run poe analize
+
+# Lint with specific tools
+uv run black --check kerykeion/
+uv run mypy kerykeion/
+```
+
+### Documentation
+```bash
+# Generate documentation
+uv run poe docs
+
+# The docs will be generated in the ./docs folder
+# Open docs/index.html in your browser to view them
+```
+
+## 📁 Project Structure
+
+```
+kerykeion/
+├── kerykeion/                 # Main package
+│   ├── __init__.py
+│   ├── aspects/               # Astrological aspects
+│   ├── charts/                # Chart generation
+│   ├── kr_types/              # Type definitions
+│   ├── settings/              # Configuration
+│   └── ...
+├── tests/                     # Test suite
+├── examples/                  # Usage examples
+├── docs/                      # Generated documentation
+├── pyproject.toml            # Project configuration
+├── uv.lock                   # Dependency lock file
+└── README.md
+```
+
+## 🔧 Adding Dependencies
+
+### Production Dependencies
+```bash
+# Add a new dependency
+uv add requests
+
+# Add with specific version
+uv add "pydantic>=2.0.0"
+```
+
+### Development Dependencies
+```bash
+# Add development dependency
+uv add --group dev pytest-mock
+
+# Add to specific group
+uv add --group test pytest-benchmark
+```
+
+## 🌟 Development Workflow
+
+1. **Create a feature branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make your changes**
+   - Write code following the existing style
+   - Add tests for new functionality
+   - Update documentation if needed
+
+3. **Test your changes**
+   ```bash
+   # Run tests
+   uv run poe test
+   
+   # Check code style
+   uv run poe format
+   uv run poe analize
+   ```
+
+4. **Commit and push**
+   ```bash
+   git add .
+   git commit -m "feat: add your feature description"
+   git push origin feature/your-feature-name
+   ```
+
+5. **Create a Pull Request**
+   - Go to GitHub and create a PR
+   - Ensure all CI checks pass
+
+## 🐛 Debugging
+
+### Running Python Scripts
+```bash
+# Run any Python script with the project environment
+uv run python your_script.py
+
+# Start interactive Python with all dependencies
+uv run python
+```
+
+### Common Issues
+
+**Issue: Import errors**
+```bash
+# Make sure you're using uv run
+uv run python -c "import kerykeion"
+```
+
+**Issue: Dependencies not found**
+```bash
+# Resync dependencies
+uv sync --dev
+```
+
+**Issue: Tests failing**
+```bash
+# Run tests with verbose output
+uv run pytest -v
+
+# Run specific test with debugging
+uv run pytest tests/test_specific.py -s -vvv
+```
+
+## 📊 Code Style Guidelines
+
+- **Line length**: 120 characters (configured in Black)
+- **Type hints**: Required for public APIs
+- **Docstrings**: Use Google style for all public functions
+- **Testing**: Aim for >90% code coverage
+
+### Example Function
+```python
+def calculate_aspect(planet1: Planet, planet2: Planet) -> AspectData:
+    """Calculate the aspect between two planets.
+    
+    Args:
+        planet1: The first planet
+        planet2: The second planet
+        
+    Returns:
+        AspectData containing the calculated aspect information
+        
+    Raises:
+        ValueError: If planets are invalid
+    """
+    # Implementation here
+    pass
+```
+
+## 🤝 Contributing
+
+1. Check the [Issues](https://github.com/g-battaglia/kerykeion/issues) for open tasks
+2. Look for issues labeled `good first issue` if you're new
+3. Comment on an issue before starting work
+4. Follow the development workflow above
+5. Be patient and responsive during code review
+
+## 📞 Getting Help
+
+- **Documentation**: [kerykeion.net](https://www.kerykeion.net/)
+- **Issues**: [GitHub Issues](https://github.com/g-battaglia/kerykeion/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/g-battaglia/kerykeion/discussions)
+
+## 🔄 Updating Dependencies
+
+```bash
+# Update all dependencies to latest compatible versions
+uv sync --upgrade
+
+# Update specific dependency
+uv add "requests>=2.32.0" --upgrade
+
+# Check for outdated dependencies
+uv tree
+```
+
+## 🏗️ Building the Package
+
+```bash
+# Build wheel and source distribution
+uv build
+
+# The built packages will be in the dist/ folder
+```
+
+---
+
+**Happy coding! 🚀** If you encounter any issues with this setup, please open an issue on GitHub.

kerykeion-5.0.0a8/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE.txt
+recursive-include kerykeion *.xml
+recursive-include kerykeion *.json
+recursive-include kerykeion *.se1

{kerykeion-5.0.0a7 → kerykeion-5.0.0a8}/PKG-INFO

@@ -1,40 +1,36 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: kerykeion
-Version: 5.0.0a7
+Version: 5.0.0a8
 Summary: A python library for astrology.
+Project-URL: Homepage, https://www.kerykeion.net/
+Project-URL: Repository, https://github.com/g-battaglia/kerykeion
+Author-email: Giacomo Battaglia <kerykeion.astrology@gmail.com>
 License: AGPL-3.0
-Keywords: astrology,ephemeris,astrology library,birtchart,svg,zodiac,zodiac-sing,astronomical-algorithms,synastry,astrology-calculator
-Author: Giacomo Battaglia
-Author-email: kerykeion.astrology@gmail.com
-Requires-Python: >=3.9,<4.0
+License-File: LICENSE
+Keywords: astrology,astrology library,astrology-calculator,astronomical-algorithms,birtchart,ephemeris,svg,synastry,zodiac,zodiac-sing
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
-Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: License :: OSI Approved :: GNU General Public License (GPL)
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Scientific/Engineering :: Astronomy
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Dist: pydantic (>=2.5,<3.0)
-Requires-Dist: pyswisseph (>=2.10.3.1,<3.0.0.0)
-Requires-Dist: pytz (>=2024.2,<2025.0)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
-Requires-Dist: requests-cache (>=1.2.1,<2.0.0)
-Requires-Dist: scour (>=0.38.2,<0.39.0)
-Requires-Dist: simple-ascii-tables (>=1.0.0,<2.0.0)
-Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
-Project-URL: Homepage, https://www.kerykeion.net/
-Project-URL: Repository, https://github.com/g-battaglia/kerykeion
+Requires-Python: >=3.9
+Requires-Dist: pydantic>=2.5
+Requires-Dist: pyswisseph>=2.10.3.1
+Requires-Dist: pytz>=2024.2
+Requires-Dist: requests-cache>=1.2.1
+Requires-Dist: requests>=2.32.3
+Requires-Dist: scour>=0.38.2
+Requires-Dist: simple-ascii-tables>=1.0.0
+Requires-Dist: typing-extensions>=4.12.2
 Description-Content-Type: text/markdown
 
 <h1 align="center">Kerykeion</h1>
@@ -638,4 +634,3 @@ If using Kerykeion in published or academic work, please cite as follows:
 Battaglia, G. (2025). Kerykeion: A Python Library for Astrological Calculations and Chart Generation.
 https://github.com/g-battaglia/kerykeion
 ```
-

kerykeion-5.0.0a8/TODO.md

@@ -0,0 +1,52 @@
+# TODO – Development Roadmap
+
+**Legend:**
+
+- `[ ]` – To do  
+- `[>]` – In progress  
+- `[x]` – Completed  
+- `[KO]` – Removed / No longer needed  
+
+**Priority levels:**
+- 🟥 High  
+- 🟧 Medium  
+- 🟨 Low  
+
+---
+
+## Version 5 Tasks
+
+### 🟥 High Priority
+
+- [ ] FIX WHEEL ONLY CHARTS!
+- [ ] Fix labels  (eg. "Aspetti Tra [...]")  
+- [x] Refactor structure using the new `AstrologicalSubjectModel` and a factory class to instantiate objects in multiple ways:
+  - [ ] Online  
+  - [ ] Offline  
+  - [ ] With UTC ISO 8601 string  
+  - [ ] With current UTC time  
+  - [ ] With only active planets  
+- [ ] Discepolo's Score in Synastry
+- [x] Add weekday name to the output  
+- [ ] Add planetary speed and direction  
+- [ ] Create utility function to retrieve all active planets  
+- [ ] Full documentation for the library and AstrologerAPI
+- [ ] More "air space" around objects in the chart
+- [x] More colorful themes (eg. "strawberry")
+- [ ] Correct the displayed file name (browser tab/title)
+- [ ] NatalAspects and SynatryAspect with inheritance of ActivePoints
+- [ ] Fix unit tests
+- [ ] Complete all the arab parts and other points in the chart
+
+
+### 🟧 Medium Priority
+
+- [ ] Finalize and integrate new examples into the documentation  
+
+### 🟨 Low Priority
+
+- [ ] Implement Gauquelin Sector as an additional house system mode (`G`)
+- [ ] Create unit tests for polar circle edge cases
+- [ ] `get_trasnlation` function for multiple languages
+
+

kerykeion-5.0.0a8/docs/index.html

@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./kerykeion.html"/>
+</head>
+</html>