kerykeion  by g-battaglia

Python library for astrology, generating charts and extracting structured data

created 5 years ago
438 stars

Top 69.2% on sourcepulse

GitHubView on GitHub
Project Summary

Kerykeion is a Python library for data-driven astrological calculations and SVG chart generation. It caters to developers and researchers needing to programmatically access and visualize astrological data, supporting birth, synastry, transit, and composite charts. The library aims to provide a clean, accessible, and integrable approach to astrological computations.

How It Works

Kerykeion leverages a data-driven approach, calculating planetary and house positions, identifying aspects, and rendering detailed SVG charts. It supports various astrological configurations, including different zodiac types (Tropical, Sidereal with modes like LAHIRI), house systems (Placidus, Koch, etc.), and perspectives (Geocentric, Heliocentric). This flexibility allows for precise and customizable astrological analyses.

Quick Start & Requirements

  • Install via pip: pip3 install kerykeion
  • Requires Python 3.9 or higher.
  • For city-based geolocation, an optional geonames_username is needed if online=True.
  • Official documentation: https://kerykeion.astrology/ (Note: Link provided in README is not active, assuming this is the intended URL)

Highlighted Details

  • Generates various SVG chart types: Birth, Synastry, Transit, Composite, and Wheel-only variants.
  • Supports customization of output directory, chart language (multiple languages available), minified SVGs, and SVGs without CSS variables for broader compatibility.
  • Enables retrieval of detailed astrological data, including planet positions, house placements, and aspects.
  • Integrates with LLM and AI applications and offers a companion Web API (AstrologerAPI).

Maintenance & Community

The project is maintained by g-battaglia. Support for further development is encouraged via donations. Contact information for collaboration and inquiries is provided.

Licensing & Compatibility

Licensed under AGPL-3.0. This license requires derivative works to be open-sourced under the same terms. For closed-source applications, using the external AstrologerAPI is recommended as a compliant alternative.

Limitations & Caveats

The AGPL-3.0 license may be restrictive for commercial closed-source applications. While the README mentions extensive house system support, it notes that Gauquelin Sectors are not supported.

Health Check
Last commit

2 days ago

Responsiveness

1 week

Pull Requests (30d)
2
Issues (30d)
0
Star History
45 stars in the last 90 days

Explore Similar Projects

Starred by Simon Willison Simon Willison(Author of Django), Jared Palmer Jared Palmer(Ex-VP of AI at Vercel; Founder of Turborepo; Author of Formik, TSDX), and
1 more.

cli by planetscale

0.2%
625
CLI tool for PlanetScale database management
created 4 years ago
updated 3 days ago
Feedback? Help us improve.