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:

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
python3 -m venv venv
source venv/bin/activate
pip install -e .

testing

you can install the current pre-release from codeberg packages:

# with pip
pip install ephem-cli \
  --pip-args="--index-url https://codeberg.org/api/packages/sailorfe/pypi/simple/ --extra-index-url https://pypi.org/simple --pre"
# with pipx
pipx install ephem-cli \
  --pip-args="--index-url https://codeberg.org/api/packages/sailorfe/pypi/simple/ --extra-index-url https://pypi.org/simple --pre"

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.

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.2.tar.gz (208.4 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.2-py3-none-any.whl (42.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ephem_cli-2.0.2.tar.gz
Algorithm Hash digest
SHA256 854ebc13a8357a3dfdc6be426252034e79cf0fa6c86cfd7ac78ab1887b768a87
MD5 fea279ade947f4d6c25c21d3ef26f154
BLAKE2b-256 1bb1e3818e0c6d6dfa581c741242248c531611b25f11b9c08e05a397df1ba452

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ephem_cli-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2f95e08580b2eba850519d314a7d1f56b4a4ba05cb910c3889a8e4aec2107b14
MD5 e22343d8e2b94c71394e487ba52dba9b
BLAKE2b-256 f3b9991007121a9a7af8bad06de134bd82fe7e3e94d0742ac1a3aabef606a761

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