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 765226d0b7 Merge branch 'main' into features 3 years ago
.github build: prepare for the distribution (#10) 3 years ago
kosmorrolib docs: add docs for get_ephemerides() (#9) 3 years ago
tests refactor: remove the dead code (#8) 3 years ago
.coveragerc ci: fix code coverage 3 years ago
.editorconfig chore: add editorconfig 3 years ago
.gitignore build: prepare for the distribution (#10) 3 years ago
CHANGELOG.md build: bump version 0.10.0 3 years ago
CONTRIBUTING.md docs: add docs and license 3 years ago
LICENSE docs: add docs and license 3 years ago
Makefile build: fix the tag recipe 3 years ago
Pipfile docs: add docs for get_ephemerides() (#9) 3 years ago
README.md docs: fix coverage badge 3 years ago
setup.py build: prepare for the distribution (#10) 3 years ago
tests.py build: prepare for the distribution (#10) 3 years ago

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)