kpyto0o/dir_igor

Дир_ижер папок

dir_igor - Directory Structure to JSON and Markdown and back transformer

Скрипт для дир_ижирования файлами в директории. Этот проект представляет собой Python-скрипт, который рекурсивно обходит указанную директорию и формирует её структуру в виде вложенных словарей, после чего сохраняет эту структуру в файл формата JSON или формирует сплошной текст в формате markdown.

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

Для работы скрипта достаточно стандартной библиотеки Python версии 3.11 и выше.

Шаг 1: Клонирование репозитория

Склонируйте репозиторий к себе на компьютер:

git clone <URL_репозитория>
cd directory_structure

Шаг 2: Создание файла конфигурации исключений

Отредактируйте под себя файл config.exclude в корневой директории проекта и добавьте туда маски файлов и директорий, которые вы хотите исключить. Пример файла config.exclude:

*.pyc
*.log
__pycache__

Шаг 3: Запуск скрипта

Запустите скрипт из командной строки, передав абсолютный путь к директории:

python directory_structure.py /абсолютный/путь/к/директории

Если вы хотите использовать свой файл конфигурации исключений, укажите его путь с помощью опции --exclude:

python directory_structure.py /абсолютный/путь/к/директории --exclude /путь/к/config.exclude

Генерация Markdown-файла

Для генерации содержимого всех файлов в формате markdown используйте опцию --markdown:

python directory_structure.py /абсолютный/путь/к/директории --markdown

Обновление файлов по JSON

Если вы хотите обновить содержимое файлов по предоставленному JSON-файлу, используйте опцию --update:

python directory_structure.py /абсолютный/путь/к/директории --update /путь/к/файлу.json

Пример использования

Структура директории

test_directory/
├── file1.txt
├── file2.log
├── file3.pyc
└── subdir1/
    ├── file4.txt
    └── file5.log

Файл config.exclude

*.pyc
*.log
subdir1

Запуск скрипта

python directory_structure.py /абсолютный/путь/к/test_directory

Ожидаемый результат

После выполнения скрипта в директории test_directory появится файл directory_structure.json со следующей структурой:

{
    "file1.txt": "Содержимое файла file1.txt"
}