iQ WorkBook

Система накопления и управления знаниями для любой из областей человеческой деятельности, как профессиональной, так и в рамках увлечений, хобби. Это касается домашнего хозяйства, животноводства, кулинарии, образования, обработки материалов, ручного труда, и конечно же, программирования и разработки электроники. То есть всего того, где необходимо делать небольшие, но качественные заметки о том или ином процессе, используемых в нем материалах, технологиях и особенностях процесса работы. Иными словами - это настоящая «копилка мастера», на чем бы он не специализировался.

Философия, идея и концепция проекта

Проект своими корнями уходит в iQRecipe и «iQNotes - прототип» (см. «Основа проекта»). Это, если можно так сказать, - компиляция, в основном, этих двух проектов, отказ от тупиковых направлений развития и ненужного функционала.

Идея создания книги рецептов в области обработки материалов принадлежала одному из пользователей. Им было высказано предложение о создании клона программы iQRecipe для записи составов клёв. Так же поступило предложенеи об еще одном клоне - для записи рыболовных хитростей. Причем каждый из пользователей не хотел отказываться от использования iQRecipe по основному назначению, а складывать все записи в одну базу данных неудобно чисто практически. Кроме того, мы сами давно хотели адаптировать проект iQRecipe для записи готовых решений в области программирования, поскольку система подсветки кода в iQNotes не позволяла делать ее для нескольких языков одновременно.

Каждая запись - это небольшая шпаргалка или рецепт с внятными сведениями о том, как делается то или иное дело, выполняется процесс или технологическая операция. Каждая запись входит в какую-то книгу, а совокупность книг составляет каталог данных или архив (по сути - нереляционную базу данных). Каталог данных хранится в домашней папке пользователя и назвается «Коллекция iQNotes». Каждая книга каталога - это единый файл с записями, который достаточно просто перенести на внешний диск и передать другому мастеру, сохранить в архив, сбросить в облако. Кроме того, готовую книгу можно использовать как справочную систему программ или их комплекса — диалог поддержки открытия файлов книги находится на проекте iQUnits.

В программе имеется механизм поиска записей. Поиск внутри записей не ведется - это бессмысленно и в прототипах не использовалось в виду небольшого объема каждой записи. Однако предусмотрена подсветка искомого материала. Программа имеет интуитивно понятный интерфейс и логику работы проверенную временем.

Основа проекта

Прототипами и основными донорами идей проекта выступили

Установка

Для того чтобы выполнить установку программы, необходимо клонировать репозиторий (скачать и распаковать архив с релизом), открыть в папке с ним терминал и последовательно выполнить следующие команды:

pip install iQWorkBook
sudo python3 install.py

Если вы хотите запустить программу без установки - клонируте репозиторий и запускайте в нем файл __main__.py, но в этом случае вам придется создавать значок программы самостоятельно.

Возможные проблемы

После установки программа может быть не работоспособна. Это может быть связано с тем что в системе отсутсвуют словари дял проверки орфографии. Для их установки нужно либо установить полную версию LibreOffice либо выполнить в терминале:

sudo apt-get install hunspell hunspell-ru-lebedev hunspell-en

или использовать другую систему проверки синтаксиса.

Документация и справочная система

Документация к проекту находится в папке /doc и в разделе wiki. Кроме того ведется «Книга проекта»

Лицензия

MIT

Дополнительные сведения

пока не написаны

Навигация