A library that computes the ephemerides.
Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.
Jérôme Deuchnord 1dc41c5566
build: prepare for the distribution (#10)
3 роки тому
.github build: prepare for the distribution (#10) 3 роки тому
kosmorrolib docs: add docs for get_ephemerides() (#9) 3 роки тому
tests refactor: remove the dead code (#8) 3 роки тому
.coveragerc ci: fix code coverage 3 роки тому
.editorconfig chore: add editorconfig 3 роки тому
.gitignore build: prepare for the distribution (#10) 3 роки тому
CONTRIBUTING.md docs: add docs and license 3 роки тому
LICENSE docs: add docs and license 3 роки тому
Makefile build: prepare for the distribution (#10) 3 роки тому
Pipfile docs: add docs for get_ephemerides() (#9) 3 роки тому
README.md docs: fix coverage badge 3 роки тому
setup.py build: prepare for the distribution (#10) 3 роки тому
tests.py build: prepare for the distribution (#10) 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)