AudionAudion

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

INSTALL_RU.md

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

English · Руководство · Справочник

Содержание

Проект переносимый: он не устанавливается в систему, не пишет в реестр и целиком живёт в своей папке. Скопировать папку на другую машину — достаточная «установка».


Требования

Windows. Программа рассчитана на Windows: перенос колонок по адресу работает через Excel, а окно поднимается на системном движке Edge WebView2.

Excel. Нужен только команде «Перенести колонки по адресу»: именно через него сохраняются формулы, оформление и порядок строк основной книги. Остальные команды без Excel работают.

Интернет. Нужен один раз для сборки окружения и потом изредка — для скачивания реестра ОКТМО.

Собранный portable-проект ничего больше не требует: Python лежит внутри, в папке runtime.


Запуск

СпособЧто делает
Start.exeОткрыть окно программы
launcher_gui.cmdТо же самое
launcher_project_ru.cmdМеню проекта на русском: прогоны, настройки, сборка
launcher_project.cmdТо же меню на английском
launcher_tools.cmdСлужебное меню: проверка окружения, лицензии, релиз
builder_main.cmdСборка portable-окружения

Launcher окна ищет Python в этом порядке:

  1. runtime\pythonw.exe
  2. runtime\python.exe
  3. runtime\python\pythonw.exe
  4. runtime\python\python.exe
  5. системный py -3.12

Найденный интерпретатор поднимает локальный сервер на 127.0.0.1:8080 и открывает окно на движке Edge WebView2. Идентификатор процесса окна пишется в logs/gui_server.pid.

Если окно не открылось

Задайте AUDION_GUI_CONSOLE=1 и запустите launcher снова — он откроется в консоли, и сообщения об ошибках будут видны:

set AUDION_GUI_CONSOLE=1 && launcher_gui.cmd

Частые причины:

вовсе; освободите порт.

сборках его ставят отдельно. Как обходной путь окно открывается в браузере.


Сборка окружения

Нужна только если вы получили проект без папки runtime или пересобираете его.

builder_main.cmd — меню сборки:

ПунктЧто делает
[01] PYTHON ENV CMDСобрать portable-окружение (основной путь)
[02] PYTHON ENV PSТо же через PowerShell
[03] FZFУстановить или обновить system_core\fzf.exe для меню launcher-ов
[09] PORTABLE OFFLINEУстановка из локального wheelhouse без сети
[70] CLEAN INSTALL CACHEОчистить кэш сборки; собранный runtime остаётся
[71] VERIFY / DOCTORПроверить окружение и импорты
[77] MAKE RELEASE ARCHIVEСобрать релизный архив

Установка без интернета

Если в проекте есть папка wheelhouse с колёсами зависимостей, окружение собирается из неё: install\install_portable_offline.cmd или пункт [09] PORTABLE OFFLINE.

Проверка

[71] VERIFY / DOCTOR — или install\verify_portable_env.cmd — проверяет интерпретатор и импорт всех зависимостей. Это первое, что стоит запустить, если что-то не работает.


Зависимости

ПакетЗачем
pandasТабличные операции
openpyxlЧтение и запись XLSX
rapidfuzzПриблизительное сравнение названий улиц
pymorphy3, pymorphy3-dicts-ruПадежные формы названий населённых пунктов
PyMuPDFТекстовый слой PDF
pywin32Работа с Excel при переносе колонок
nicegui, pywebviewОкно программы
pyyamlФайлы настроек
tqdm, richПрогресс и вывод в журнал
pytest, beautifulsoup4Тесты

Тексты лицензий всех сторонних компонентов лежат в licenses/.


Папки проекта

ПапкаЧто в нейМожно чистить
system_coreИсходный кодНет
configНастройки, ключи и пины ОКТМОНет
dataРеестр ОКТМО и справочник регионовРеестр скачивается заново
runtimePortable PythonПересобирается
wheelhouseКолёса для офлайн-установкиДа
inputИсходные файлыДа
outputРезультатыДа
reportОтчёты прогоновДа
logsЖурналыДа
workspaceПромежуточные файлыДа
releaseАрхивы результатовДа
docsДокументацияНет
licensesЛицензии сторонних компонентовНет
testsТестыНет

Первичное создание рабочих папок — install\init_folders.cmd.


Обслуживание

Очистка проекта. cleanup_project.cmd удаляет наработанные артефакты: кэши, временные конвертации, журналы, отчёты и пересобираемый runtime. Код, настройки, документация, исходники, результаты и утверждённые эталоны сохраняются.

Кодировка CMD-файлов. После правки любого .cmd запускайте install\Check-CmdEncoding.cmd: файлы должны остаться UTF-8 без BOM с переносами CRLF. Иначе кириллица в меню превратится в мусор.

Обновление зависимостей. install\Update-Requirements-Lock.cmd перегенерирует lock-файл.

Реестр ОКТМО обновляется не отсюда, а кнопкой в окне — см. ОКТМО.


Перед большим прогоном

Проверьте окружение (VERIFY / DOCTOR), работайте с копиями важных таблиц и держите источники, эталон и результаты в разных папках.

Первый прогон на новом наборе данных делайте на десятке строк, ответ для которых известен заранее.

Все проекты