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 50b9569e5e
feat: use Skyfield-Data library instead of downloading needed files at first time (#22)
преди 3 години
.github chore: use GitHub forms to report bugs преди 3 години
kosmorrolib feat: use Skyfield-Data library instead of downloading needed files at first time (#22) преди 3 години
tests feat(event): add support for Earth seasons (#24) преди 3 години
.coveragerc test: fix coverage config преди 3 години
.editorconfig ci: add support for Windows (#14) преди 3 години
.gitignore chore: add EditorConfig to GitPod config преди 3 години
.gitpod.yml chore: add EditorConfig to GitPod config преди 3 години
CHANGELOG.md build: bump version 0.11.2 преди 3 години
CONTRIBUTING.md chore: fix GitPod button on contribution doc преди 3 години
LICENSE docs: add docs and license преди 3 години
Makefile chore: fix files to commit on tag преди 3 години
Pipfile feat: use Skyfield-Data library instead of downloading needed files at first time (#22) преди 3 години
README.md docs: remove Discord badge преди 3 години
setup.py build: prepare for the distribution (#10) преди 3 години
tests.py test: add missing module in tests (related to #18) (#19) преди 3 години

README.md

Kosmorrolib - a library to compute your ephemerides!

Coverage Status Version on PyPI

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)