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 746ce953c8
ci: add support for Windows (#14)
преди 3 години
.github ci: add support for Windows (#14) преди 3 години
kosmorrolib build: update version number преди 3 години
tests fix: add missing enums to the exposed model, rename data.py to model.py (#11) преди 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.0 преди 3 години
CONTRIBUTING.md docs: add docs and license преди 3 години
LICENSE docs: add docs and license преди 3 години
Makefile ci: add support for Windows (#14) преди 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 ci: add support for Windows (#14) преди 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)