opastro 0.1.2

Open-source astrology engine for developers: CLI, API, Swiss Ephemeris, and explainable horoscope generation.

OpAstro Engine (Open Core)

Opastro is a deterministic horoscope engine built for two use cases:

• a developer-friendly Python library
• a high-UX terminal CLI (opastro)

The open-core repo ships calculations + lightweight built-in meanings. Richer premium narrative packs are available via numerologyapi.com.

One-line promise: Open-source astrology engine for developers: CLI, API, Swiss Ephemeris, and explainable horoscope generation.

5-Minute Quickstart

python3 -m pip install -U opastro
opastro doctor
opastro horoscope --period daily --sign ARIES --target-date 2026-04-03

Terminal Demo

opastro horoscope --period daily --sign ARIES --target-date 2026-04-03 --format markdown

# OPASTRO REPORT
- **Type:** `horoscope`  - **Sign:** `ARIES`  - **Period:** `daily`

## General (...)
...

Open Core vs Premium

Product	Includes	Best For
opastro (this repo)	Open calculations, deterministic engine, lite meanings, installable CLI, local API	Developers building local tools, prototypes, integrations, and transparent workflows
numerologyapi.com	Premium narrative depth, richer editorial packs, production-grade premium reading flows	Apps and businesses needing deeper reading content and premium user-facing experiences

What Is Open Here

• Swiss Ephemeris-based astrology calculations
• Deterministic factor derivation and section scoring
• Built-in lite renderer (no external dataset required)
• FastAPI service endpoints
• Python package + installable CLI
• Test suite covering API, CLI, rendering, caching, and health checks

What Is Not Included

• Private premium meaning dataset and editorial packs
• Premium content production pipeline assets

Requirements

• Python 3.11+

Install (PyPI)

python3 -m pip install opastro

Install (Editable, Contributors)

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -e .

CLI

Running with no arguments opens the welcome UI:

opastro

Command Catalog

Command	Description
opastro	Main welcome UI with OPASTRO ASCII banner + quick start
opastro init	Interactive onboarding to create/update a default profile
opastro profile ...	Manage saved profiles (save, list, show, use)
opastro welcome	Show welcome UI explicitly
opastro catalog	List periods, sections, signs, and planets
opastro doctor	Runtime diagnostics (python path, platform, ephemeris mode)
opastro horoscope	Generate standard reports (daily/weekly/monthly/yearly)
opastro birthday	Generate birthday-cycle yearly report
opastro planet	Generate planet-focused report
opastro natal	Generate natal report + wheel chart assets (SVG/PNG/map/PDF)
opastro explain	Show why each section line appeared (factor provenance)
opastro completion --shell ...	Generate shell completion scripts
opastro ui	Launch interactive TUI with section drill-down
opastro batch	Multi-sign / multi-date report generation
opastro serve	Run local FastAPI app

Report Flags

• --period {daily,weekly,monthly,yearly} (required for horoscope, planet)
• --sign ARIES
• --target-date YYYY-MM-DD
• --sections general,career,money
• --birth-date YYYY-MM-DD
• --birth-time HH:MM
• --lat <float> --lon <float>
• --timezone <IANA timezone>
• --zodiac-system {sidereal,tropical} (default: tropical)
• --ayanamsa {lahiri,fagan_bradley,krishnamurti,raman,yukteswar}
• --house-system {placidus,whole_sign,equal,koch}
• --node-type {true,mean}
• --tenant-id <id>
• --json
• --format {text,json,markdown,html}
• --export <path>

CLI Examples

# Interactive setup (creates active default profile)
opastro init

# Save profile defaults without prompts
opastro profile save --name work --sign ARIES --format markdown --set-active

# Switch active profile
opastro profile use work

# Explain why lines appeared
opastro explain --kind horoscope --period daily --sign ARIES --target-date 2026-04-03 --format markdown

# Interactive TUI
opastro ui --period daily --sign ARIES --target-date 2026-04-03

# Batch generation
opastro batch --kind horoscope --period daily --signs ARIES,TAURUS --date-from 2026-04-03 --date-to 2026-04-05 --format markdown --export-dir reports/batch

# Daily sign-mode
opastro horoscope --period daily --sign ARIES --target-date 2026-04-03

# Daily personalized (houses + daily_house_focus enabled if time+coords provided)
opastro horoscope \
  --period daily \
  --target-date 2026-04-03 \
  --birth-date 1997-08-17 \
  --birth-time 09:30 \
  --lat 4.0511 \
  --lon 9.7679 \
  --timezone Africa/Douala

# Birthday-cycle report
opastro birthday --sign TAURUS --target-date 2026-04-03

# Planet-focused monthly report
opastro planet --period monthly --planet mercury --sign TAURUS --target-date 2026-04-03

# Natal report + premium artifact exports
opastro natal \
  --user-name "Dakidarts" \
  --birth-date 2004-06-14 \
  --birth-time 09:30 \
  --lat 4.0511 \
  --lon 9.7679 \
  --timezone Africa/Douala \
  --wheel-svg reports/natal-wheel.svg \
  --wheel-png reports/natal-wheel.png \
  --house-map reports/natal-house-map.json \
  --pdf reports/natal-report.pdf

# Raw JSON output
opastro horoscope --period weekly --sign LEO --json

# Export markdown report
opastro horoscope --period daily --sign ARIES --format markdown --export reports/aries.md

Notes:

• If --user-name is omitted, natal personalization falls back to active profile name; if none exists, it falls back to OPASTRO.
• Wheel assets include a profile context block (name, birth timestamp, coordinates, timezone, house system, zodiac system, generation timestamp) and a responsive combined symbols legend.

API

Run local API:

opastro serve --host 127.0.0.1 --port 8000 --reload

Or directly:

uvicorn horoscope_engine.main:app --host 127.0.0.1 --port 8000 --reload

Endpoints

• GET /health
• POST /horoscope
• POST /birthday-horoscope
• POST /planet-horoscope
• POST /natal-birthchart
• POST /natal-birthchart/wheel.svg
• POST /natal-birthchart/wheel.png
• POST /natal-birthchart/house-overlay
• POST /natal-birthchart/report.pdf
• GET /metrics
• POST /admin/pregenerate

Minimal API Call

curl -X POST http://127.0.0.1:8000/horoscope \
  -H "Content-Type: application/json" \
  -d '{"period":"daily","sign":"ARIES"}'

Natal Birthchart API Call

curl -X POST http://127.0.0.1:8000/natal-birthchart \
  -H "Content-Type: application/json" \
  -d '{"birth":{"date":"2004-06-14","time":"09:30","coordinates":{"latitude":4.0511,"longitude":9.7679},"timezone":"Africa/Douala"}}'

Environment Variables

Variable	Default	Purpose
SE_EPHE_PATH	auto-detected	Swiss Ephemeris path override
REDIS_URL	unset	Enable Redis cache if set
REDIS_KEY_PREFIX	""	Redis key prefix
CONTENT_HEALTHCHECK_DISABLE	0	Skip startup content/schema check
CONTENT_HEALTHCHECK_FAIL_FAST	0	Raise startup error when health check issues are found
PREGEN_TOKEN	unset	Protect /admin/pregenerate with X-Admin-Token

Developer UX Extras

# Diagnose and preview auto-fixes
opastro doctor --fix --dry-run

# Apply auto-fixes (installs editable package + deps)
opastro doctor --fix

# Generate shell completions
opastro completion --shell bash
opastro completion --shell zsh
opastro completion --shell fish

Testing

python3 -m pip install -e ".[dev]"
PYTHONPATH=src python3 -m pytest -q

Build And Publish (PyPI)

# One-time tooling
python3 -m pip install -U build twine

# Clean old artifacts
rm -rf dist build src/*.egg-info

# Build wheel + sdist
python3 -m build

# Validate package metadata/rendering
python3 -m twine check dist/*

# Production upload
python3 -m twine upload dist/*

Docs

Start here: docs/README.md

Python Library Examples

1) Basic Daily Report (Sign Mode)

from datetime import date

from horoscope_engine.config import ServiceConfig
from horoscope_engine.models import HoroscopeRequest, Period
from horoscope_engine.service import HoroscopeService

service = HoroscopeService(ServiceConfig())

response = service.generate(
    HoroscopeRequest(
        period=Period.DAILY,
        sign="ARIES",
        target_date=date(2026, 4, 3),
    )
)

print(response.report_type.value, response.sign, response.period.value)
for section in response.sections:
    print(f"[{section.section.value}] {section.summary}")

2) Personalized Report (Birth + Coordinates)

from datetime import date

from horoscope_engine.config import ServiceConfig
from horoscope_engine.models import BirthData, Coordinates, HoroscopeRequest, Period
from horoscope_engine.service import HoroscopeService

service = HoroscopeService(ServiceConfig())

response = service.generate(
    HoroscopeRequest(
        period=Period.WEEKLY,
        target_date=date(2026, 4, 3),
        birth=BirthData(
            date=date(1997, 8, 17),
            time="09:30",
            coordinates=Coordinates(latitude=4.0511, longitude=9.7679),
            timezone="Africa/Douala",
        ),
    )
)

print(response.sign)
print(response.data.snapshot.rising_sign)
print(response.data.snapshot.house_cusps)

3) Planet-Focused Report

from datetime import date

from horoscope_engine.config import ServiceConfig
from horoscope_engine.models import Period, PlanetHoroscopeRequest, PlanetName
from horoscope_engine.service import HoroscopeService

service = HoroscopeService(ServiceConfig())

response = service.generate_planet(
    PlanetHoroscopeRequest(
        period=Period.MONTHLY,
        planet=PlanetName.MERCURY,
        sign="TAURUS",
        target_date=date(2026, 4, 3),
    )
)

print(response.report_type.value)
print(response.sections[0].title)

4) JSON Serialization

from datetime import date

from horoscope_engine.config import ServiceConfig
from horoscope_engine.models import HoroscopeRequest, Period
from horoscope_engine.service import HoroscopeService

service = HoroscopeService(ServiceConfig())
payload = service.generate(
    HoroscopeRequest(period=Period.DAILY, sign="LEO", target_date=date(2026, 4, 3))
).model_dump(mode="json")

print(payload["report_type"], payload["period"], payload["sign"])

Want Premium Narrative Depth?

Unlock richer editorial readings and premium API access: numerologyapi.com

---

⭐ If you find this project useful, give it a star on GitHub!