Skip to main content

A minimal and configurable astrology CLI

Project description

ephem

a minimal, opinionated astrology CLI tool

pypi license: agpl v3

ephem is a linux-native cli for astrologers, built on hellenistic tradition with electional and horary practice in mind. it generates horoscopes and monthly ephemerides with professional accuracy, and stores time and geodata in a local database that can be edited as YAML files.

currently supports:

  • all 47 sidereal offsets from the Swiss Ephemeris
  • the sun, moon, and eight planets (mercury–pluto)
  • choice of lunar node calculation method
  • clear table output for charts and ephemerides
  • graceful handling of incomplete data

deliberately out of scope:

  • house cusps and placements
  • graphical charts
  • asteroids

table of contents

installation

build dependencies

because pyswisseph wraps the Swiss Ephemeris C library, you'll need to run the following:

  • debian-based: sudo update && sudo apt install build-essential python3-dev pipx
  • fedora/rhel: sudo dnf install @development-tools python3-devel pipx
  • arch: sudo pacman -Syu base-devel python python-pipx
  • alpine: doas apk add base python3-dev pipx

note: if you use uv, feel free to exclude pipx.

stable

the stable release of ephem can be installed directly from pypi:

global installation

# using pipx
pipx install ephem-cli

# using uv
uv tool install ephem-cli

run directly

# run directly without installing
uvx --from ephem-cli ephem

build from source

git clone https://codeberg.org/sailorfe/ephem.git
cd ephem
uv run ephem                        # run directly
# or
uv sync && uv run ephem             # for development

testing

you can install the current pre-release from codeberg:

# run pre-release directly from codeberg
uvx --from https://codeberg.org/sailorfe/ephem ephem-cli

# or install pre-release
uv tool install ephem-cli \
  --index https://codeberg.org/api/packages/sailorfe/pypi/simple/ \
  --prerelease allow

usage

ephem {now,cast,cal,data}
  • now and cast to calculate and optionally save charts
  • cal to calculate monthly ephemerides
  • data to interact with chart database

examples

get a chart for right now:

ephem now

save your location to avoid typing coordinates every time:

ephem now -y 30 -x -80 --save-config

cast a chart for a specific date and time:

ephem cast 1996-08-26 17:20 "Jeon Soyeon" -z Asia/Seoul -y 37.488167 -x 127.085472

get a monthly ephemeris:

ephem cal 1989 dec

tutorial

for more detailed examples, see the ephem tutorial. (i think it's pretty good.)

testing

ephem has a test suite. run it with:

make test

these tests currently focus on CLI behavior and database interactions since core calculations are handled by the Swiss Ephemeris library. more tests are planned as the project grows!

contributing

ephem is in early development. contributions are welcome, especially from developers with experience in astrology software, but what it really needs at this stage is testers. join the humble discord server!

acknowledgments

ephem draws inspiration from:

license

licensed under AGPL v3 per the Swiss Ephemeris; see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ephem_cli-2.0.6.tar.gz (465.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ephem_cli-2.0.6-py3-none-any.whl (43.0 kB view details)

Uploaded Python 3

File details

Details for the file ephem_cli-2.0.6.tar.gz.

File metadata

  • Download URL: ephem_cli-2.0.6.tar.gz
  • Upload date:
  • Size: 465.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.2

File hashes

Hashes for ephem_cli-2.0.6.tar.gz
Algorithm Hash digest
SHA256 f1131c5114a66260e0fc5a2adfa856c8cc2e4d4fa4cb2a0e6eef4660d2506bb3
MD5 7f701e0b317909d8448e8d2d918d3322
BLAKE2b-256 31deed158d585221c6b85d21083a49d6551db668561656946afad7e0fd5ba8e9

See more details on using hashes here.

File details

Details for the file ephem_cli-2.0.6-py3-none-any.whl.

File metadata

  • Download URL: ephem_cli-2.0.6-py3-none-any.whl
  • Upload date:
  • Size: 43.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.2

File hashes

Hashes for ephem_cli-2.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 705e2647b5511ee0bbf40b41d51d0d0ced3f6ff20681bfaef3ee31217b420962
MD5 c97c24cdb8188703d8546fde7ec5a4e1
BLAKE2b-256 bc102eb0f0ff5e77ddcd8d52f87f7572c75c12371266b6fceb51a6f2adcb90c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page