A library that computes the ephemerides.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Jérôme Deuchnord 761a43bcbd build: bump version 1.0.0 2 years ago
.github feat: add support for Python 3.10 (#32) 2 years ago
kosmorrolib build: bump version 1.0.0 2 years ago
.coveragerc test: fix coverage config 2 years ago
.editorconfig ci: add support for Windows (#14) 2 years ago
.gitignore chore: add EditorConfig to GitPod config 2 years ago
.gitpod.yml chore: add EditorConfig to GitPod config 2 years ago
CHANGELOG.md build: bump version 1.0.0 2 years ago
CONTRIBUTING.md chore: fix GitPod button on contribution doc 2 years ago
LICENSE.md docs(license): migrate to GNU Affero General Public License v3 (#27) 2 years ago
Makefile test: enhance the coverage (#31) 2 years ago
Pipfile feat: use Skyfield-Data library instead of downloading needed files at first time (#22) 2 years ago
README.md chore: prepare for 1.0.0 2 years ago
setup.py chore: update URL 2 years ago
tests.py test: enhance the coverage (#31) 2 years ago

README.md

Kosmorrolib - a library to compute your ephemerides!

Coverage Status Version on PyPI IRC: #kosmorro on Libera.Chat

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)