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

stable

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

# run directly without installing
uvx ephem-cli

# or install globally
uv tool install ephem-cli

# traditional methods
pip install --user ephem-cli    # if you use pip
pipx install ephem-cli          # if you use pipx, especially debian/ubuntu

or you can build it from source from the main branch:

git clone https://codeberg.org/sailorfe/ephem.git
cd ephem
uv run -m ephem.cli             # run directly
# or
uv sync && uv run -m ephem.cli     # 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.3.tar.gz (460.7 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.3-py3-none-any.whl (42.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ephem_cli-2.0.3.tar.gz
Algorithm Hash digest
SHA256 19c6e4803ee9757552c64099aafe957100566e6e81905e357068c32cbc7cd62d
MD5 f90bbe1dae843e6a82078978fd94ecf1
BLAKE2b-256 bf5d9aa5eab7b0e4ac63510b35c191c96be1fbb410d818f39b19c15d6fd5a3a3

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ephem_cli-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f003409c30eaf95795a93f6d5aa28aaaacc49fb98fab6067f234c8e598ec7465
MD5 0281e57c39740befdfe2559c6a3b43f4
BLAKE2b-256 7957e7becd6f2ae1df9997865e23dff77ac2130b864635d4ea4772400efc928d

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