RepoTool - Простой инструмент для документации и восстановления проектов

RepoTool — это единый скрипт для быстрой генерации Markdown-документации из исходного кода проекта и последующего восстановления этого проекта из .md файла. Инструмент разработан для максимальной простоты и интеграции с контекстным меню Windows.

Основные возможности

• Два режима работы:
  1. Генерация: При выборе папки создает один .md файл, содержащий структуру и код всех текстовых файлов проекта.
  2. Восстановление: При выборе .md файла восстанавливает полную структуру проекта, создавая подпапку с именем проекта.
• Интерактивный выбор пути: Перед сохранением результата (файла документации или папки проекта) открывается стандартный диалог Windows для выбора места.
• Простота: Никаких зависимостей, кроме стандартной библиотеки Python.
• Интеграция с Windows: Легко добавляется в контекстное меню для папок и .md файлов.

Установка

1. Подготовка скрипта

Сохраните код из файла RepoTool.py.

2. Сборка в .exe

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

1. Установите PyInstaller:

   pip install pyinstaller

2. Откройте терминал в папке со скриптом RepoTool.py и выполните команду:

   pyinstaller --onefile --noconsole RepoTool.py

   • --onefile: создает один .exe файл.
   • --noconsole: убирает черное консольное окно при запуске.

3. В папке dist появится файл RepoTool.exe. Переместите его в удобное постоянное место, например, C:\Program Files\RepoTool\RepoTool.exe.

3. Интеграция с контекстным меню

1. Откройте файл setup_menu.reg в текстовом редакторе.
2. Замените C:\\Program Files\\RepoTool\\RepoTool.exe на ваш реальный путь к файлу RepoTool.exe. Внимание: в пути используются двойные обратные слэши (\\).
3. Сохраните файл setup_menu.reg в кодировке UTF-16 LE (в Блокноте Windows это "Файл" -> "Сохранить как..." -> Кодировка: "Юникод"). Это необходимо для корректного отображения русских символов.
4. Дважды щелкните по .reg файлу и подтвердите добавление данных в реестр.
5. Перезапустите Проводник (Explorer) через Диспетчер задач для применения изменений.

Использование

• Создать документацию: Щелкните правой кнопкой мыши по папке с вашим проектом и выберите в контекстном меню "Создать документацию проекта". Откроется диалог, где вы сможете выбрать имя и место сохранения .md файла.
• Восстановить проект: Щелкните правой кнопкой мыши по файлу ..._documentation.md и выберите "Восстановить проект из документации". Откроется диалог, где нужно выбрать базовую папку для восстановления. Внутри этой папки будет создана новая директория с именем вашего проекта.

---

Дополнительный функционал: работа с бинарными файлами

По умолчанию скрипт работает только с текстовыми файлами. Вы можете активировать поддержку бинарных файлов (изображений, шрифтов, PDF и т.д.), которые будут упаковываться в .zip архив.

Как активировать:

1. Откройте скрипт RepoTool.py в текстовом редакторе.
2. Найдите блок, который начинается с комментария ### ДОПОЛНИТЕЛЬНЫЙ ФУНКЦИОНАЛ ###.
3. Раскомментируйте (удалите символ # в начале строк) весь код внутри этого блока, включая вызовы функций в главной части скрипта.
4. Пересоберите .exe файл с помощью PyInstaller, как описано в шаге установки.

После активации:

• При генерации документации рядом с .md файлом будет создан .zip архив с тем же именем, содержащий все нетекстовые файлы проекта.
• При восстановлении проекта скрипт автоматически найдет и распакует этот .zip архив в папку с восстановленным проектом.