tldr-python-client (tldr.py)

tldr-python-client (tldr.py) — консольный Python клиент для сервиса упрощённых справочных страниц tldr pages (command line client for tldr).

tldr pages — развиваемые сообществом упрощённые справочные страницы (simplified man pages). Авторы проекта решили привнести в консоль лаконичную документацию, содержащую только основную информацию. В коллекции упрощённых справочных страниц представлены команды с кратким описанием их назначения и даны примеры наиболее частого использования запрошенной утилиты/команды.

Проект tldr pages является альтернативой man, info и --help (-h), выводящей лишь краткую справку с наиболее полезной информацией, своего рода набор подсказок или шпаргалок, не являющихся полноценной заменой официальной документации к приложениям. Для получения доступа к страницам tldr необходим клиент, имеется множество клиентов от сообщества написанных на всех популярных языках, одним из таких клиентов является tldr-python-client.

tldr.py предоставляет минимальный необходимый набор опций, при пером запуске клиентом загружается библиотека справочных страниц для локального использования (каталог локального хранилища: ~/.cache/tldr), обновление библиотеки осуществляется вручную. Можно настроить поведение и вывод клиента, установив переменные среды, например в файле ~/.bashrc задать:

export TLDR_COLOR_NAME="cyan"
export TLDR_COLOR_DESCRIPTION="white"
export TLDR_COLOR_EXAMPLE="green"
export TLDR_COLOR_COMMAND="red"
export TLDR_COLOR_PARAMETER="white"
export TLDR_CACHE_ENABLED=1
export TLDR_CACHE_MAX_AGE=720
export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/master/pages"
export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip"
export TLDR_LANGUAGE="en"

Клиент загружает архив библиотеки справочных страниц и извлекает их в каталог локального кеша, в зависимости от заданных параметров (TLDR_CACHE_ENABLED=1) клиент вначале пытается загрузить данные из кеша и загружает данные с сервиса только при отсутствующем или сильно устаревшем кеше. Клиент может сразу загружать запрошенные данные с сервиса и сохранять в кеш для повторного просмотра, можно задать время устаревания кеша и предпочитаемый язык.

tldr-python-client имеет минимально необходимый набор опций, выводя стандартного вида описание утилиты и компактный список наиболее часто используемых команд. При возникновении проблем с клиентом необходимо сначала удалить файлы кеша, можно использовать собственный источник tldr страниц, вместо источника "по умолчанию". Клиент достаточно подробно документирован (на английском), конфликтует с большинством других клиентов и не может использоваться совместно.

Лицензия: MLT (The MIT License)

Домашняя страница