folder_icons Readme Generator

Генератор таблиц с демо-версиями иконок для ридми проекта folder_icons.

Весь код просто ужасен. Я старался написать его как можно быстрее и забивал на читабельность и оптимизацию. Возможно, позже я все переделаю, но пока и так сойдёт.

Установка

$ git clone https://github.com/dan-sazonov/folder_icons-gen.git
$ cd folder_icons-gen
$ python3 -m pip install -r requirements.txt

Все тесты проводились на Python 3.9.0 на Windows 10 x64. Работоспособность на других ОС и/или с другими версиями интерпретатора не гарантируется.

Применение

Быстрый запуск:

$ python3 main.py -i - запуск в интерактивном режиме. После предложения введите абсолютный путь до папки проекта folder_icons и каталоги, которые вы хотели бы исключить (если файлы в них не изменились).

Как это работает:
Сначала скрипт создает json файл следующего вида:

{
"Название_папки": {
    "имя_файла.ico": "Название Программы",
    "имя_файла.ico": "Название Программы"
  }
}

Название программы создается из имени файла путем замены разделителей на пробелы и первых букв на заглавные, поэтому возможны неточности. Вы можете проверить файл и изменить "Название Программы". Во избежание ошибок остальное трогать не надо.
Затем, по данным из этого файла запускается генератор html таблицы, которую дальше можно вставить в .md файл ридми. Важно: скрипт не умеет объединять пустые ячейки на последних строках таблиц, поэтому придется руками. Если это не сделать, гитхаб будет криво отображать таблицу.

Больше возможностей:

$ python3 main.py -h - краткая справка;
$ python3 main.py -p - создает json файл (см. выше). Настройки прописываются ручками в словаре SETTINGS в config.py;
$ python3 main.py -c - создает таблицу по данным из json файла;
$ python3 main.py -d - режим отладки с блэкджеком и принтами после каждого ифа.

Автор

Автор кода и репозитория - @dan-sazonov.
Связаться со мной:
✈️ Telegram
📧 Email

Лицензия

Весь код распространяется по лицензии GPL-3.0 License . Подробнее см. в файле.