A library that computes the ephemerides.
 
 
Jérôme Deuchnord 158dec2689 feat(events): add support for lunar eclipses 3 년 전
.github docs(license): migrate to GNU Affero General Public License v3 (#27) 3 년 전
kosmorrolib feat(events): add support for lunar eclipses 3 년 전
tests docs(license): migrate to GNU Affero General Public License v3 (#27) 3 년 전
.coveragerc test: fix coverage config 3 년 전
.editorconfig ci: add support for Windows (#14) 3 년 전
.gitignore build: prepare for the distribution (#10) 3 년 전
CHANGELOG.md build: bump version 0.11.2 3 년 전
CONTRIBUTING.md docs: add docs and license 3 년 전
LICENSE.md docs(license): migrate to GNU Affero General Public License v3 (#27) 3 년 전
Makefile feat(event): add support for Earth seasons (#24) 3 년 전
Pipfile feat: use Skyfield-Data library instead of downloading needed files at first time (#22) 3 년 전
README.md docs: fix coverage badge 3 년 전
setup.py docs(license): migrate to GNU Affero General Public License v3 (#27) 3 년 전
tests.py docs(license): migrate to GNU Affero General Public License v3 (#27) 3 년 전

README.md

Kosmorrolib - a library to compute your ephemerides!

Coverage Status Version on PyPI Discord

Installation

Requirements

Kosmorrolib requires the following software to work:

  • Python ≥ 3.7.0
  • PIP

Production environment

Keep in mind that Kosmorrolib is not considered as stable for now.

PyPI

Kosmorrolib is available on PyPI: pip install kosmorrolib.

Development environment

First, install Pipenv.

Clone this repository and run pipenv sync to install all the dependencies. And that’s all, your development environment is ready for the fight! 👏

Using the Kosmorrolib

The Kosmorrolib provides three functions that you can use in your code:

#!/usr/bin/env python3

import kosmorrolib
from datetime import date

position = kosmorrolib.Position(50.5824, 3.0624)

# Get the moon phase for today
moon_phase = kosmorrolib.get_moon_phase()

# Get the moon phase for June 9th, 2021
moon_phase = kosmorrolib.get_moon_phase(date.fromisoformat('2021-06-09'))

# Get a list of objects representing the ephemerides of today.
ephemerides = kosmorrolib.get_ephemerides(position)

# Get a list of objects representing the ephemerides of June 9th, 2021.
ephemerides = kosmorrolib.get_ephemerides(position, date.fromisoformat('2021-06-09'))

# Get a list of objects representing the events of today.
events = kosmorrolib.get_events()

# Get a list of objects representing the events on June 9th, 2021.
events = kosmorrolib.get_events(date.fromisoformat('2021-06-09'))

# Note that each method provides an optional parameter for the timezone:
moon_phase = kosmorrolib.get_moon_phase(timezone=2)
ephemerides = kosmorrolib.get_ephemerides(position, timezone=2)
events = kosmorrolib.get_events(timezone=2)