ketu 0.2.0__tar.gz

ketu-0.2.0/CHANGELOG.md

@@ -0,0 +1,86 @@
+# Changelog
+
+> 🇫🇷 Consultez la version française dans `fr/CHANGELOG.md`.
+
+All notable changes to Ketu are documented here.
+
+This project follows the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+format and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2025-10-27
+
+### Added
+
+- Full packaging setup for a PyPI release
+- `pyproject.toml` metadata and dependencies
+- `requirements.txt` for a minimal install
+- Public exports in `ketu/__init__.py`
+- Expanded README with usage examples
+- PyPI, Python versions, and license badges
+- `MANIFEST.in` to ship data files
+- GitHub Actions workflow for automated tests
+- GitHub Actions workflow for PyPI publishing
+- CI coverage for Python 3.9 through 3.13
+- `ketu` CLI entry point
+- Support for 13 celestial bodies (added True Node)
+- English and French documentation
+
+### Changed
+
+- Fixed and hardened the unit tests
+- Removed the obsolete `_timea.py` profiling helper
+- Optimised package structure for distribution
+- Aligned the documentation with the new layout
+
+### Technical
+
+- Official support for Python 3.10–3.13
+- Pytest configuration embedded in `pyproject.toml`
+- Coverage configuration for CI analysis
+- Package installable via `pip install ketu`
+- Works seamlessly in virtual environments
+
+## [0.1.0] - 2024-01-XX
+
+### Added
+
+- Interactive CLI to compute positions and aspects
+- Planetary position computations through pyswisseph
+- Detection of major aspects with orb handling
+- Conversion helpers between UTC and Julian Day
+- Retrogradation detection
+- Complete documentation with Sphinx and MyST
+- Initial PyPI-ready packaging
+- Foundational unit tests
+
+### Features
+
+- Support for 12 initial celestial bodies
+- Seven major aspects (conjunction to opposition)
+- Zodiac sign computations
+- Orb system inspired by Abu Ma'shar
+- LRU cache to improve performance
+- Requires Python 3.9+
+- Dependencies: numpy, pyswisseph
+- Modular, documented codebase
+
+## [0.0.1] - 2023-01-XX
+
+### Initial
+
+- Prototype groundwork
+- Basic position calculations
+- Command-line interface
+
+---
+
+## Versioning Convention
+
+- **MAJOR**: Incompatible API changes
+- **MINOR**: Backward-compatible feature additions
+- **PATCH**: Backward-compatible bug fixes
+
+## Links
+
+- [Version comparison](https://github.com/alkimya/ketu/compare/)
+- [All releases](https://github.com/alkimya/ketu/releases)

ketu-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Loc Cosnier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ketu-0.2.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include requirements.txt
+recursive-include fr *.md
+recursive-include docs *.md *.py *.txt
+recursive-include res *.png
+global-exclude __pycache__
+global-exclude *.py[co]

ketu-0.2.0/PKG-INFO

@@ -0,0 +1,231 @@
+Metadata-Version: 2.4
+Name: ketu
+Version: 0.2.0
+Summary: Library to compute astronomical bodies positions and planetary aspects between them
+Author-email: Loc Cosnier <loc.cosnier@pm.me>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/alkimya/ketu
+Project-URL: Documentation, https://ketu.readthedocs.io
+Project-URL: Repository, https://github.com/alkimya/ketu
+Project-URL: Issues, https://github.com/alkimya/ketu/issues
+Keywords: astrology,astronomy,ephemeris,aspects,planets,zodiac,swiss ephemeris
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: pyswisseph>=2.10.0
+Dynamic: license-file
+
+# Ketu
+
+[![PyPI version](https://badge.fury.io/py/ketu.svg)](https://badge.fury.io/py/ketu)
+[![Python Versions](https://img.shields.io/pypi/pyversions/ketu.svg)](https://pypi.org/project/ketu/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> 🇫🇷 Vous préférez le français ? [Consultez README.md](fr/README.md)
+
+**Ketu** is a lightweight Python library for computing the positions of astronomical bodies (Sun, Moon, planets, and the mean Node a.k.a. Rahu) and generating calendars driven by astrological aspects.
+
+This library was originally designed to generate biodynamic calendars and time series based on astrological aspects. It can be used as a basis for building astrology software.
+
+![Terminal screen](https://github.com/alkimya/ketu/blob/main/res/screen.png)
+
+## ✨ Features
+
+- 🌍 **Planetary positions** for 13 bodies (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto, Rahu/Mean Node, True North Node, Lilith)
+- ⭐ **Detection of the 7 major aspects** (Conjunction, Semi-sextile, Sextile, Square, Trine, Quincunx, Opposition)
+- 🔄 **Retrogradation detection** and planet motion helpers
+- 🕐 **Time system conversions** (UTC, Julian Day)
+- 🎯 **Orb system** based on Abu Ma'shar (787-886) and Al-Biruni (973-1050)
+- 🖥️ **Interactive CLI** for a non-programmatic workflow
+- 📊 **Python API** that fits into your own tooling
+
+## 📦 Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install ketu
+```
+
+### From source
+
+```bash
+git clone https://github.com/alkimya/ketu.git
+cd ketu
+pip install -e .
+```
+
+## 🚀 Quick Start
+
+### Interactive mode (CLI)
+
+Run the command below and answer the prompts:
+
+```bash
+ketu
+```
+
+You will be asked for:
+
+- A date (ISO format: `2020-12-21`)
+- A time (ISO format: `19:20`)
+- A timezone (for example `Europe/Paris`)
+
+The program prints:
+
+- Positions of every celestial body with zodiac signs
+- All inter-planet aspects with their orbs
+
+### Programmatic usage
+
+```python
+from datetime import datetime
+from zoneinfo import ZoneInfo
+import ketu
+
+# Define a datetime
+dtime = datetime(2020, 12, 21, 19, 20, tzinfo=ZoneInfo("Europe/Paris"))
+jday = ketu.utc_to_julian(dtime)
+
+# Display planetary positions
+ketu.print_positions(jday)
+
+# Display aspects
+ketu.print_aspects(jday)
+```
+
+### Additional examples
+
+#### Compute a planet position
+
+```python
+from datetime import datetime
+from zoneinfo import ZoneInfo
+import ketu
+
+dtime = datetime(2024, 10, 26, 12, 0, tzinfo=ZoneInfo("UTC"))
+jday = ketu.utc_to_julian(dtime)
+
+sun_long = ketu.long(jday, 0)
+print(f"Sun longitude: {sun_long:.2f}°")
+
+sign, deg, mins, secs = ketu.body_sign(sun_long)
+print(f"Position: {ketu.signs[sign]} {deg}°{mins}'{secs}\"")
+```
+
+#### Check whether a planet is retrograde
+
+```python
+import ketu
+
+# Mars (body id = 4)
+if ketu.is_retrograde(jday, 4):
+    print("Mars is retrograde")
+else:
+    print("Mars is direct")
+```
+
+#### Calculate all aspects for a given day
+
+```python
+import ketu
+
+aspects_data = ketu.calculate_aspects(jday)
+
+for aspect in aspects_data:
+    body1, body2, i_asp, orb = aspect
+    print(f"{ketu.body_name(body1)} - {ketu.body_name(body2)}: "
+          f"{ketu.aspects['name'][i_asp].decode()} (orb: {orb:.2f}°)")
+```
+
+## 📚 Documentation
+
+The full documentation is hosted on [Read the Docs](https://ketu.readthedocs.io) (French by default, English via the language toggle).
+
+Included sections:
+
+- **Installation**: detailed setup instructions
+- **Quickstart**: guided tour of the basics
+- **Concepts**: astrological and astronomical background
+- **API Reference**: all functions documented
+- **Examples**: advanced usage patterns
+
+## 🛠️ Requirements
+
+- Python 3.10 or higher
+- `numpy` ≥ 1.20.0 — numerical routines and arrays
+- `pyswisseph` ≥ 2.10.0 — Swiss Ephemeris bindings
+
+> The dependency on `pyswisseph` is scheduled for removal in a future release, replaced by pure NumPy implementation.
+
+## 📋 Supported bodies
+
+| Body | ID | Orb | Average speed (°/day) |
+|------|----|-----|-----------------------|
+| Sun | 0 | 12° | 0.986 |
+| Moon | 1 | 12° | 13.176 |
+| Mercury | 2 | 8° | 1.383 |
+| Venus | 3 | 10° | 1.200 |
+| Mars | 4 | 8° | 0.524 |
+| Jupiter | 5 | 10° | 0.083 |
+| Saturn | 6 | 10° | 0.034 |
+| Uranus | 7 | 6° | 0.012 |
+| Neptune | 8 | 6° | 0.007 |
+| Pluto | 9 | 4° | 0.004 |
+| Rahu (Mean Node) | 10 | 0° | -0.013 |
+| True North Node | 11 | 0° | -0.013 |
+| Lilith (Black Moon) | 12 | 0° | -0.113 |
+
+## 🎯 Supported aspects
+
+| Aspect | Angle | Orb coefficient |
+|--------|-------|-------------------|
+| Conjunction | 0° | 1 |
+| Semi-sextile | 30° | 1/6 |
+| Sextile | 60° | 1/3 |
+| Square | 90° | 1/2 |
+| Trine | 120° | 2/3 |
+| Quincunx | 150° | 5/6 |
+| Opposition | 180° | 1 |
+
+## 🗺️ Roadmap
+
+- [ ] Removal of dependency on pyswisseph
+- [ ] Pure numpy implementation of planetary calculations
+- [ ] Search for exact aspects between two dates
+- [ ] Generation of aspect calendars
+- [ ] API for progressions and directions
+- [ ] Support for more celestial bodies (asteroids, etc.)
+
+## 🤝 Contribution
+
+Contributions are welcome! Feel free to:
+
+- Open an issue to report a bug or suggest a feature
+- Submit a pull request
+- Improve the documentation
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
+
+## 📄 License
+
+This project is licensed under MIT. See the [LICENSE](LICENSE) file for more details.
+
+## 📧 Contact
+
+Loc Cosnier - [@alkimya](https://github.com/alkimya)
+
+Project: [https://github.com/alkimya/ketu](https://github.com/alkimya/ketu)
+
+Translated with DeepL.com (free version)

ketu-0.2.0/README.md

@@ -0,0 +1,203 @@
+# Ketu
+
+[![PyPI version](https://badge.fury.io/py/ketu.svg)](https://badge.fury.io/py/ketu)
+[![Python Versions](https://img.shields.io/pypi/pyversions/ketu.svg)](https://pypi.org/project/ketu/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> 🇫🇷 Vous préférez le français ? [Consultez README.md](fr/README.md)
+
+**Ketu** is a lightweight Python library for computing the positions of astronomical bodies (Sun, Moon, planets, and the mean Node a.k.a. Rahu) and generating calendars driven by astrological aspects.
+
+This library was originally designed to generate biodynamic calendars and time series based on astrological aspects. It can be used as a basis for building astrology software.
+
+![Terminal screen](https://github.com/alkimya/ketu/blob/main/res/screen.png)
+
+## ✨ Features
+
+- 🌍 **Planetary positions** for 13 bodies (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto, Rahu/Mean Node, True North Node, Lilith)
+- ⭐ **Detection of the 7 major aspects** (Conjunction, Semi-sextile, Sextile, Square, Trine, Quincunx, Opposition)
+- 🔄 **Retrogradation detection** and planet motion helpers
+- 🕐 **Time system conversions** (UTC, Julian Day)
+- 🎯 **Orb system** based on Abu Ma'shar (787-886) and Al-Biruni (973-1050)
+- 🖥️ **Interactive CLI** for a non-programmatic workflow
+- 📊 **Python API** that fits into your own tooling
+
+## 📦 Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install ketu
+```
+
+### From source
+
+```bash
+git clone https://github.com/alkimya/ketu.git
+cd ketu
+pip install -e .
+```
+
+## 🚀 Quick Start
+
+### Interactive mode (CLI)
+
+Run the command below and answer the prompts:
+
+```bash
+ketu
+```
+
+You will be asked for:
+
+- A date (ISO format: `2020-12-21`)
+- A time (ISO format: `19:20`)
+- A timezone (for example `Europe/Paris`)
+
+The program prints:
+
+- Positions of every celestial body with zodiac signs
+- All inter-planet aspects with their orbs
+
+### Programmatic usage
+
+```python
+from datetime import datetime
+from zoneinfo import ZoneInfo
+import ketu
+
+# Define a datetime
+dtime = datetime(2020, 12, 21, 19, 20, tzinfo=ZoneInfo("Europe/Paris"))
+jday = ketu.utc_to_julian(dtime)
+
+# Display planetary positions
+ketu.print_positions(jday)
+
+# Display aspects
+ketu.print_aspects(jday)
+```
+
+### Additional examples
+
+#### Compute a planet position
+
+```python
+from datetime import datetime
+from zoneinfo import ZoneInfo
+import ketu
+
+dtime = datetime(2024, 10, 26, 12, 0, tzinfo=ZoneInfo("UTC"))
+jday = ketu.utc_to_julian(dtime)
+
+sun_long = ketu.long(jday, 0)
+print(f"Sun longitude: {sun_long:.2f}°")
+
+sign, deg, mins, secs = ketu.body_sign(sun_long)
+print(f"Position: {ketu.signs[sign]} {deg}°{mins}'{secs}\"")
+```
+
+#### Check whether a planet is retrograde
+
+```python
+import ketu
+
+# Mars (body id = 4)
+if ketu.is_retrograde(jday, 4):
+    print("Mars is retrograde")
+else:
+    print("Mars is direct")
+```
+
+#### Calculate all aspects for a given day
+
+```python
+import ketu
+
+aspects_data = ketu.calculate_aspects(jday)
+
+for aspect in aspects_data:
+    body1, body2, i_asp, orb = aspect
+    print(f"{ketu.body_name(body1)} - {ketu.body_name(body2)}: "
+          f"{ketu.aspects['name'][i_asp].decode()} (orb: {orb:.2f}°)")
+```
+
+## 📚 Documentation
+
+The full documentation is hosted on [Read the Docs](https://ketu.readthedocs.io) (French by default, English via the language toggle).
+
+Included sections:
+
+- **Installation**: detailed setup instructions
+- **Quickstart**: guided tour of the basics
+- **Concepts**: astrological and astronomical background
+- **API Reference**: all functions documented
+- **Examples**: advanced usage patterns
+
+## 🛠️ Requirements
+
+- Python 3.10 or higher
+- `numpy` ≥ 1.20.0 — numerical routines and arrays
+- `pyswisseph` ≥ 2.10.0 — Swiss Ephemeris bindings
+
+> The dependency on `pyswisseph` is scheduled for removal in a future release, replaced by pure NumPy implementation.
+
+## 📋 Supported bodies
+
+| Body | ID | Orb | Average speed (°/day) |
+|------|----|-----|-----------------------|
+| Sun | 0 | 12° | 0.986 |
+| Moon | 1 | 12° | 13.176 |
+| Mercury | 2 | 8° | 1.383 |
+| Venus | 3 | 10° | 1.200 |
+| Mars | 4 | 8° | 0.524 |
+| Jupiter | 5 | 10° | 0.083 |
+| Saturn | 6 | 10° | 0.034 |
+| Uranus | 7 | 6° | 0.012 |
+| Neptune | 8 | 6° | 0.007 |
+| Pluto | 9 | 4° | 0.004 |
+| Rahu (Mean Node) | 10 | 0° | -0.013 |
+| True North Node | 11 | 0° | -0.013 |
+| Lilith (Black Moon) | 12 | 0° | -0.113 |
+
+## 🎯 Supported aspects
+
+| Aspect | Angle | Orb coefficient |
+|--------|-------|-------------------|
+| Conjunction | 0° | 1 |
+| Semi-sextile | 30° | 1/6 |
+| Sextile | 60° | 1/3 |
+| Square | 90° | 1/2 |
+| Trine | 120° | 2/3 |
+| Quincunx | 150° | 5/6 |
+| Opposition | 180° | 1 |
+
+## 🗺️ Roadmap
+
+- [ ] Removal of dependency on pyswisseph
+- [ ] Pure numpy implementation of planetary calculations
+- [ ] Search for exact aspects between two dates
+- [ ] Generation of aspect calendars
+- [ ] API for progressions and directions
+- [ ] Support for more celestial bodies (asteroids, etc.)
+
+## 🤝 Contribution
+
+Contributions are welcome! Feel free to:
+
+- Open an issue to report a bug or suggest a feature
+- Submit a pull request
+- Improve the documentation
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
+
+## 📄 License
+
+This project is licensed under MIT. See the [LICENSE](LICENSE) file for more details.
+
+## 📧 Contact
+
+Loc Cosnier - [@alkimya](https://github.com/alkimya)
+
+Project: [https://github.com/alkimya/ketu](https://github.com/alkimya/ketu)
+
+Translated with DeepL.com (free version)