Xnote

Xnote — это лёгкая система для личных заметок, которая предлагает разнообразные функции управления данными и стремится освободить пользователей от информационного перегруза. Вот основные характеристики системы:

• Разнообразные функции управления данными: поддержка различных форматов заметок и функций управления файлами.
• Расширяемость: система поставляется с набором инструментов, но также предоставляет возможность разработки плагинов для удовлетворения индивидуальных потребностей.
• Кроссплатформенность: работает на Windows, Mac и Linux, а также может быть развёрнута в облаке или запущена локально.
• Полный контроль над данными: позволяет работать с различными базами данных.
• Поддержка небольших групп пользователей: ориентирована на индивидуальное использование, не рекомендуется для крупных многопользовательских сред или совместной работы.

На данный момент Xnote позиционируется как небольшой продукт для личного использования и не фокусируется на следующих направлениях:

• Поддержка больших групп пользователей.
• Функции совместной работы для нескольких пользователей.

Если вы любите технологии, цените гибкость обработки данных и хотите полностью контролировать свои документы, этот продукт может стать интересным выбором. Вы можете попробовать его и оставить отзыв.

Демо-версия доступна по адресу: https://1k5u680558.goho.co/.

Для тестирования предоставляются учётные данные: user01/123456, user02/123456. Обратите внимание, что администратор периодически очищает данные, поэтому не рекомендуется хранить важные данные.

Вот некоторые примеры страниц:

1. Список функций:

2. Записная книжка:

3. Страница Markdown:

Адрес проекта

• GitHub: https://github.com/xupingmao/xnote.
• Gitee: https://gitee.com/xupingmao/xnote.

При возникновении проблем во время использования, пожалуйста, создайте issue или оставьте комментарий на главной странице проекта.

Установка и запуск

Установка на физическом компьютере

Установка зависимостей

• Python 3.6 или выше.
• Установите необходимые пакеты:
  • Минимальная установка (с использованием SQLite): python3 -m pip install -r config/requirements.min.txt.
  • Для Mac/Linux: python -m pip install -r config/requirements.txt.
  • Для Windows: python -m pip install -r config/requirements.win.txt.

Конфигурация и запуск

По умолчанию конфигурация находится в файле config/boot/boot.default.properties. Подробные инструкции можно найти в комментариях к файлу конфигурации.

# Переключитесь в каталог xnote:
> cd xnote
# Скопируйте файл конфигурации и настройте его под свои нужды:
> cp config/boot/boot.min.properties boot.local.properties
# Запустите приложение:
> python3 app.py --config boot.local.properties

После запуска приложения вы можете использовать его, перейдя по адресу http://localhost:1234/. По умолчанию используется учётная запись администратора с паролем 123456.

Docker-compose

1. Создайте каталог для хранения постоянных данных: mkdir data.
2. Скопируйте конфигурационный файл: cp ./config/boot/boot.default.properties ./boot.local.properties.
3. Настройте файл конфигурации в соответствии со своими потребностями.
4. Выполните команду: docker-compose up -d.

Развёртывание в облачных сервисах

• Новый сайт SAЕ TODO.
• CentOS — BAE от Байду.

Основные функции

Управление заметками

• Поддерживает различные форматы: Markdown, таблицы, галереи, списки.
• Организация заметок: через записные книжки, метки и приоритеты.
• Функция обмена: в подробной информации о заметке нажмите «Ещё» в выпадающем списке, чтобы поделиться статьёй с незарегистрированными пользователями.
• Управление приоритетами: возможность пометить заметки как приоритетные и архивировать их.
• Резервное копирование: история изменений заметок.
• Поиск: поиск по всей библиотеке знаний и внутри проектов.
• Комментарии: поддержка комментариев для зарегистрированных пользователей.
• Статистика посещений: недавние и часто используемые посещения.
• Другие инструменты для работы с документами.

Управление файлами

• Различные представления: список и сетка.
• Операции с файлами: загрузка, скачивание, создание, удаление, переименование, перемещение и т. д.
• Инструменты для файлов: редактор кода, текстовый редактор, двоичный просмотрщик, поиск содержимого файла и др.
• Поддержка больших файлов: поддержка частичной загрузки при скачивании и возможность загрузки файлов размером до 1 ГБ (проверено).
• Расширение: поддержка разработки плагинов.

Панель инструментов

• Документация Python (pydoc).
• Обработка текста (сравнения текстов, генерация кода, генерация паролей).
• Инструменты кодирования (Base64, MD5, преобразование в разные системы счисления и т. п.).
• Генераторы штрихкодов и QR-кодов.
• Обработка изображений (объединение, разделение, преобразование в оттенки серого).
• Предоставляет возможности расширения, позволяя разработчикам создавать собственные плагины.

Расширение системы

Механизм плагинов

Поскольку потребности каждого пользователя уникальны, единая система не всегда может удовлетворить все требования. Разработчики могут создавать плагины для расширения функциональности системы в соответствии с индивидуальными потребностями. Подробнее см. в документации Плагины.

Основные особенности:

• Плагины могут отслеживать системные сообщения, включая заметки, напоминания, файлы, время и другие типы сообщений.
• Плагины можно классифицировать с помощью свойства «category», чтобы они отображались в меню заметок, файлов и других функций.
• Можно создавать шаблоны для создания плагинов.

Разработка дополнительных модулей

• Xnote уже упакован и загружен на PyPI [xnote-web], что позволяет разрабатывать дополнительные модули на основе модульного подхода.