Особенности

Возможности консольного клиента Wallabag

Из цикла: CLI клиент Wallabag

И так, что же предлагает консольный клиент для сервиса отложенного чтения Wallabag.

Установка и конфигурация

Прежде всего, необходимо установить приложение. Для этого запускаем:

> pip install wallabag-client

Затем нужно будет ответить на несколько вопросов для настройки доступа к вашему сервису Wallabag. Для этого используется команда:

> wallabag config
Enter the url of your Wallabag instance [https://www.wallabag.com/]:
Enter your Wallabag username []:
Enter your Wallabag password []:
Enter the client id of your Wallabag API []:
Enter the client secret of your Wallabag API []:

Список команд

В справке находится весь список команд, который поддерживает приложение:

> Usage: wallabag [OPTIONS] COMMAND [ARGS]...
Options:
  --config TEXT       Use custom configuration file
  --debug             Enable debug logging to stdout
  --debug-level TEXT  Debug level
  --version           Show the version and exit.
  -h, --help          Show this message and exit.

Commands:
  add             Add a new entry to wallabag.
  anno            Annotation commands.
  config          Start configuration.
  delete          Delete an entry from wallabag.
  delete-by-tags  Delete entries from wallabag by tags.
  export          Export entry to file.
  info            Get entry information.
  list            List the entries on the wallabag account.
  open            Open entry in browser.
  read            Toggle the read-status of an existing entry.
  repl            Start an interactive shell.
  show            Show the text of an entry.
  star            Toggle the starred-status of an existing entry.
  tags            Retrieve and print all tags.
  update          Toggle the read or starred status or change the title...
  update-by-tags  Set the read or starred status of an existing entries...

Утилита позволяет добавлять статьи из командной строки, редактировать, добавлять и удалять тэги, экспортировать и так далее. Каждая команда имеет свой ключ -h для отображения справки по этой команде:

> wallabag add -h
Usage: wallabag add [OPTIONS] URL

  Add a new entry to wallabag.

Options:
  -t, --title TEXT  Add a custom title.
  -r, --read        Mark as read.
  -s, --starred     Mark as starred.
  -a, --tags TEXT   Comma-separated list of tags
  -q, --quiet       Hide the output if no error occurs.

Планы

На данный момент у меня есть две функции, которые я хотел бы добавить в утилиту.

  1. Это более удобный способ чтения записей, с запоминанием позиции, может быть с добавлением аннотаций. В данный момент для чтения можно использовать только команду show, которая просто выводить содержимое статьи на экран и экспортируя в какой-нибудь из форматов для чтения стороними программами.
  2. Встроенная возможность отправить статью на kindle.

Цикл: CLI клиент Wallabag

  1. Introduction
  2. Особенности