From 9500efe33e4f5188faa24ec259d5b3643092daa9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Deuchnord?= Date: Sun, 6 Jun 2021 12:19:31 +0200 Subject: [PATCH] fix(pdf): update message on PDF generation failure (#187) --- README.md | 67 ++-------------------------------- _kosmorro/dumper.py | 2 +- _kosmorro/locales/messages.pot | 6 +-- 3 files changed, 7 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 6998d36..15a3980 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # ![Kosmorro](https://raw.githubusercontent.com/Kosmorro/logos/main/png/kosmorro-logo-grey.png) -[![Coverage Status](https://coveralls.io/repos/github/Kosmorro/kosmorro/badge.svg?branch=master)](https://coveralls.io/github/Kosmorro/kosmorro?branch=master) [![Version on PyPI](https://img.shields.io/pypi/v/kosmorro)](https://pypi.org/project/kosmorro) [![Discord](https://img.shields.io/discord/650237632533757965?logo=discord&label=%23kosmorro)](https://discord.gg/TVX4MSKGaa) ![Docker Pulls](https://img.shields.io/docker/pulls/kosmorro/kosmorro) [![Help translating Kosmorro!](https://hosted.weblate.org/widgets/kosmorro/-/cli/svg-badge.svg)](https://hosted.weblate.org/engage/kosmorro/) +[![Coverage Status](https://coveralls.io/repos/github/Kosmorro/kosmorro/badge.svg?branch=master)](https://coveralls.io/github/Kosmorro/kosmorro?branch=master) [![Version on PyPI](https://img.shields.io/pypi/v/kosmorro)](https://pypi.org/project/kosmorro) [![Packaging status](https://repology.org/badge/tiny-repos/kosmorro.svg)](https://repology.org/project/kosmorro/versions) [![Docker Pulls](https://img.shields.io/docker/pulls/kosmorro/kosmorro)](https://hub.docker.com/r/kosmorro/kosmorro) [![Help translating Kosmorro!](https://hosted.weblate.org/widgets/kosmorro/-/cli/svg-badge.svg)](https://hosted.weblate.org/engage/kosmorro/) [![Discord](https://img.shields.io/discord/650237632533757965?logo=discord&label=%23kosmorro)](https://discord.gg/TVX4MSKGaa) A program that calculates your astronomical ephemerides! @@ -7,60 +7,7 @@ A program that calculates your astronomical ephemerides! ### Production environment -Keep in mind that Kosmorro is still in alpha development stage and is not considered as stable. - -#### Available packages - -First thing first, check on the badge below (or on [Repology](https://repology.org/project/kosmorro/packages)) if your distribution has a package for Kosmorro. -If possible, prefer these packages, since they provide the best integration with your system, especially the update routine. - -[![Packaging status](https://repology.org/badge/vertical-allrepos/kosmorro.svg)](https://repology.org/project/kosmorro/versions) - -If it doesn't, then follow the methods ways below. - -#### Install from PyPI (Linux, macOS) - -> Note: Python 3 and PIP3 is necessary on your machine. -> Please check you have installed it before you install Kosmorro. -> If you need help to install Python 3 and PIP3, please refer to your distribution's manual. - -Kosmorro is available [on PyPI](https://pypi.org/project/kosmorro/), a repository dedicated to Python. -To install it, invoke the following command: `pip3 install kosmorro`. - -#### Windows - -Kosmorro being at an early-stage development, Windows is not supported officially for now. - -#### Docker - -Kosmorro is available on [Docker Hub](https://hub.docker.com/r/kosmorro/kosmorro)! -You can get it by running `docker pull kosmorro/kosmorro`. - -Now that you have the image, you can run it with `docker run -it kosmorro/kosmorro`. -Run Kosmorro by executing `kosmorro` in the container. - -You can also run the image with the command: `docker run kosmorro/kosmorro kosmorro [args]`. - -Note that for more convenience, you might add the following in your `.bashrc`/`.zshrc`/etc.: - -```bash -alias kosmorro="docker run kosmorro/kosmorro kosmorro" -``` - -##### Image versioning on Docker Hub - -By default, running `docker pull kosmorro/kosmorro` will download the `latest` tag by default, which corresponds to the last version of Kosmorro. -If you prefer, you can also force pulling a specific version by specifying it after the `:` character: `docker pull kosmorro/kosmorro:[version]`. - -As of version 0.10, five kinds of tags are available: - -| Tag | Description | Example -| --- | --- | --- -| `unstable` | the current code in the `master` branch, for testing purpose | `kosmorro/kosmorro:unstable` -| `latest` | the last version (equivalent to not specifying any tag) | `kosmorro/kosmorro:latest` -| `x` | the last version in the `x` major version | `kosmorro/kosmorro:0`: will pull the ![last version in the `0` major branch](https://img.shields.io/docker/v/kosmorro/kosmorro/0?style=flat-square) -| `x.y` | the last version in the `x.y` minor version | `kosmorro/kosmorro:0.10`: will pull the ![last version in the `0` major branch](https://img.shields.io/docker/v/kosmorro/kosmorro/0.10?style=flat-square) -| `x.y.z` | the exact specified version | `kosmorro/kosmorro:0.10.0` +If you want to give a try to Kosmorro, head to [its official download page](https://kosmorro.space/cli/download/) and follow the instructions that correspond to your operating system. ### Development environment @@ -89,15 +36,7 @@ Note: the first time it runs, Kosmorro will download some important files needed ### Exporting to PDF Kosmorro can export the computation results to PDF files, but this feature requires first that you install some additional dependencies. -Before you use this feature, make sure you have installed a LaTeX distribution: - -- **Linux:** install TeXLive through your packages manager. Kosmorro just needs the minimal installation, you don't need any extension. - Note: **on Ubuntu 20.04+**, you will also need the `texlive-latex-extra` package. -- **macOS**: install basic version of [MacTeX](https://www.tug.org/mactex/): - - from the official website, choose the _smaller download_ - - with Brew: `brew install basictex` - -These dependencies are not installed by default, because they take a lot of place and are not necessary if you are not interested in generating PDF files. +You can find documentation about this on [Kosmorro's website](https://kosmorro.space/cli/generate-pdf/). ## Help translating Kosmorro! diff --git a/_kosmorro/dumper.py b/_kosmorro/dumper.py index b5c704e..4c56f05 100644 --- a/_kosmorro/dumper.py +++ b/_kosmorro/dumper.py @@ -483,7 +483,7 @@ class PdfDumper(Dumper): raise KosmorroUnavailableFeatureError( _( "Building PDF was not possible, because some dependencies are not" - " installed.\nPlease look at the documentation at https://kosmorro.space " + " installed.\nPlease look at the documentation at https://kosmorro.space/cli/generate-pdf/ " "for more information." ) ) from error diff --git a/_kosmorro/locales/messages.pot b/_kosmorro/locales/messages.pot index 47e3a69..5594e47 100644 --- a/_kosmorro/locales/messages.pot +++ b/_kosmorro/locales/messages.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: kosmorro 0.10.0\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" -"POT-Creation-Date: 2021-06-05 17:59+0200\n" +"POT-Creation-Date: 2021-06-06 11:58+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -100,8 +100,8 @@ msgstr "" msgid "" "Building PDF was not possible, because some dependencies are not " "installed.\n" -"Please look at the documentation at https://kosmorro.space for more " -"information." +"Please look at the documentation at https://kosmorro.space/cli/generate-" +"pdf/ for more information." msgstr "" #: _kosmorro/dumper.py:537