kosmorro

http://kosmorro.space

Nic 4b1f06e221 feat: guess output format from output file extension (#197 ) guess output format based on output file extension check for empty output file default to .txt if no file extension provided change default output format back to txt add tests update man page fix default output format directly return output dumper use keys from dumpers in key error message fix man pages prevent output format from being overridden use first dumper key as default format update messages and formatting update help message for format argument specify list type in InvalidOutputFormat exception make default output format more apparent update messages		3 年之前
.github	docs(license): revert to license GNU AGPL (#196)	3 年之前
.scripts	feat: guess output format from output file extension (#197)	3 年之前
_kosmorro	feat: guess output format from output file extension (#197)	3 年之前
manpage	feat: guess output format from output file extension (#197)	3 年之前
test	feat: use Kosmorrolib (#162)	3 年之前
.coveragerc	ci(compatibility): test on more Python versions and on macOS (#131)	3 年之前
.editorconfig	ci(compatibility): test on more Python versions and on macOS (#131)	3 年之前
.gitignore	chore(i18n): migrate from POEditor to Weblate (#170)	3 年之前
.pylintrc	ci(compatibility): test on more Python versions and on macOS (#131)	3 年之前
CHANGELOG.md	build: bump version 0.10.1	3 年之前
CODE_OF_CONDUCT.md	docs: add code of conduct (#155)	3 年之前
CONTRIBUTING.md	chore(i18n): migrate from POEditor to Weblate (#170)	3 年之前
Dockerfile	build: fix Docker image build (#180)	3 年之前
LICENSE.md	docs(license): revert to license GNU AGPL (#196)	3 年之前
MANIFEST.in	feat: use Kosmorrolib (#162)	3 年之前
Makefile	docs(license): change license from GNU AGPL v3 to CeCILL v2.1 (#182)	3 年之前
Pipfile	feat: replace latitude and longitude with one argument alone: --position (#191)	3 年之前
Pipfile.lock	feat: replace latitude and longitude with one argument alone: --position (#191)	3 年之前
README.md	fix(pdf): update message on PDF generation failure (#187)	3 年之前
kosmorro	docs(license): revert to license GNU AGPL (#196)	3 年之前
setup.cfg	build: fix Docker image build (#180)	3 年之前
setup.py	docs(license): revert to license GNU AGPL (#196)	3 年之前

README.md

A program that calculates your astronomical ephemerides!

Installation

Production environment

If you want to give a try to Kosmorro, head to its official download page and follow the instructions that correspond to your operating system.

Development environment

Before you run Kosmorro in your development environment, check you have installed these programs on your system:

Python ≥ 3.7.0 (needed run Kosmorro)
PIP3 (needed for package management, usually installed among with Python 3)
Pipenv (needed to manage the virtual environment)

Clone this repository and run pipenv sync to install all the dependencies. Then, run Kosmorro by invoking pipenv run python kosmorro.

For comfort, you may want to invoke pipenv shell first and then just python kosmoro.

Using Kosmorro

Using Kosmorro is as simple as invoking kosmorro in your terminal!

By default, it will give you the current Moon phase and, if any, the events that will occur today. To get the rise, culmination and set of the objects of the Solar system, you will need to give it your position on Earth: get your current coordinates (with OpenStreetMap for instance), and give them to Kosmorro by invoking it with the following parameters: --latitude=X --longitude=Y (replace X by the latitude and Y by the longitude).

Kosmorro has a lot of available options. To get a list of them, run kosmorro --help, or read its manual with man kosmorro.

Note: the first time it runs, Kosmorro will download some important files needed to make the computations. They are stored in a cache folder named .kosmorro-cache located in your home directory (/home/<username> on Linux, /Users/<username> on macOS).

Exporting to PDF

Kosmorro can export the computation results to PDF files, but this feature requires first that you install some additional dependencies. You can find documentation about this on Kosmorro’s website.

Help translating Kosmorro!

Kosmorro is translated on Weblate, a popular free platform for crowd-sourced internationalization. If you speak a language that is not supported yet, feel free to contribute!