install.md

Установка программы

Table of Contents

Установка программы
- Установка для Windows
  - Неправильный, но лёгкий путь
  - Сделайте как надо—это тоже несложно
- Установка скрипта на Windows (а также Linux и Mac OS)

Установка для Windows

Неправильный, но лёгкий путь

Пользователи Windows могут загрузить самодостаточный исполняемый файл (*.exe) основанный на данном коде. Такой файл может быть найден в разделе готовых пакетов.

Конечно, использование исполняемых файлов не из самых проверенных источников всегда связано со значительным риском и мы призываем избегать таких действий, тем более, что в данном случае есть возможность сделайть, как надо. Так что лёгкий, но опасный, вариант сразу запустить загруженную программу на исполнение и быстро получить результат — может быть только вашим выбором.

Если исполняемый файл всё же был загружен и запущен двойным щелчком мыши, то программа начнёт диалог с пользователем в открывшемся окне или терминале. По ходу можно использовать всплывающие подсказки или текстовые сообщения для правильного ввода параметров. В первый раз запустите загрузку всего за один месяц—просто на пробу.

Если вы умеете пользоваться командной строкой, то запустив программу LJexport.exe в терминале можно пользоваться теми же ключами, что и при работе со скриптом.

Сделайте как надо—это тоже несложно

Правильным подходом будет загрузить исходный код программы и при необходимости установить для него среду Python3. Этот процесс в главном совпадает для разных операционных систем и описан в следующей секции.

Установка скрипта на Windows (а также Linux и Mac OS)

Хотя следующие инструкции имеют общий характер, но в основном они ориентированы на пользователей Windows, так как под Linux и требуемые программы, и опыт скорее всего есть. На всякий случай укажем, что привычный в Linux вызов Пайтона3 командой python3 в Windows сокращён до py, и мы будем использовать этот последний в дальнейшем описании.

Если у вас не установили Пайтон ранее, то скачайте и установите 3-ий Пайтон с официального сайта.

По умолчанию вам должен быть предложена последняя версия соответсвующей архитектуре вашего компьютера. Там же можно получить и дальнейшие указания по загрузке и установке.

Если у вас Windows, то можно следовать видео инструкциям по установке. В частности, не забудьте проставить галочку Add Python*.* to PATH (добавить Python в пути), хотя для успешной работы может понадобится перезагрузка.

Для пользователей Linux: мы рекомендуем создать виртуального окружения и пользоваться кодом из него.
Скачайте LJexport.zip (название файла может ещё включать его версию) либо из текущей состояния, либо из доступного релиза (последнее должно быть несколько стабильнее).
Распакуйте этот архива в ту папку, куда хотите сохранять записи дневников. Откройте командную строку (терминал) и переместитесь (команда cd) в эту папку. Убедитесь, что в ней находится Пайтоновский скрипт LJexport.py. Для этого выполните команду dir и проверьте, что LJexport.py присутствует в выведенном списке файлов.
Убедитесь, что у вас стоит загрузчик Пайтоновских модулей pipи заодно обновите его:
```
py -m pip install --upgrade pip
```
Если это по какой-то причине не сработало, то поищите совета в сети, как помочь с этим.
Когда предыдущий шаг будет успешным, установите модули Пайтон, которые обычно не входят в его базовую установку, но используются в нашем скрипте. Для этого запустите в терминале такую команду:
```
py -m pip install -r requirements.txt
```
Если вы предпочитаете использовать русский язык, то мы рекомендуем установить ещё немного необязательных пакетов:
```
py -m pip install -r optional-requirements.txt
```
Если есть желание сохранять внешние ссылки из дневниковых записей как PDF файлы, то потребуется установить ещё немного необязательных пакетов указанных в файле external-requirements.txt. Если с этим шагом не заморачиваться, то всё и так будет работать—кроме загрузки внешних ссылок.

Если их устанавливать на Linux с помощью менеджера пакетов, то необходимый исполняемый код wkhtmltopdf будет установлен автоматически.

То же самое вручную (например на Windows) делаем так.
- Ставим Пайтоновские модули:
```
py -m pip install -r external-requirements.txt
```
- Устанавливаем исполняемые файлы для [свой архитектуры]{https://wkhtmltopdf.org/downloads.html}.
- Убеждаемся, что компьютер находит путь к исполняемым файлам. Для этого обычно надо добавить строку вроде этой C:\Program Files\wkhtmltopdf\bin\ в переменную PATH среды.
Что бы работало окно пользовательского интерфейса дополнительно надо установить PyQt6, например, такой коммандой:
```
py -m pip install -r ui-requirements.txt
```
Попробуйте теперь запустить программу в тестовом режиме:
```
py -m LJexport -h
```
Если программа вывела подсказку по своему использованию, то она готова к применению. Но если вдруг окажется, что какого-то используемого модуля всё равно нет, то Пайтон будет ругаться. Скажем, если нет обычно базового модуля codecs, то он выкинет:
```
	NameError: name 'codecs' is not defined
```
— тогда доставьте этот модуль вручную через pip, т.е.:
```
	py -m pip install codecs
```

Дополнительная информация об использовании программы может быть найдена здесь или можно Вернутся к Вики.