the directory scanner

Сканер каталогов

Сканер каталогов - это библиотека Python, предназначенная для упрощения процесса сканирующих структур каталогов и создания комплексного списка файлов и папок. Он обеспечивает удобный способ рекурсивного прохождения каталогов, игнорируя конкретные файлы и папки, указанные пользователем.

Функции:

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

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

1. Установите библиотеку с помощью PIP:

    pip install the-directory-scanner
   

2. Импортируйте функцию scan_directory из библиотеки и используйте ее для сканирования каталога:

    from the_directory_scanner import scan_directory
   
   scan_result = scan_directory ( directory = "." , output_file_name = "directory_structure.txt" ,
                               ignored_items = ( '.git' , '.idea' , 'venv' , '__pycache__' ,))

3. Доступ к сгенерированной структуре каталога в выходном файле ( directory_structure.txt в этом примере), чтобы просмотреть результаты.

4. Если вы хотите изменить структуру, импортируйте функцию prettify_structure и предоставьте путь к сгенерированному файлу:

    from the_directory_scanner import scan_directory , prettify_structure
   
   scan_result = scan_directory ( directory = "." , output_file_name = "directory_structure.txt" ,
                                ignored_items = ( '.git' , '.idea' , 'venv' , '__pycache__' ,))
   
   prettify_structure ( output_file = scan_result , spaces_to_trim = 4 , lines_to_trim = 1 )

---

Выходные примеры directory_structure.txt :

 directory_structure.txt
LICENSE.rst
README.md
setup.py
usage.py
directory_scanner/
    directory_structure.txt
    main.py
    __init__.py

---

О:

Библиотека сканеров каталогов направлена ​​на то, чтобы упростить задачи сканирования каталогов путем предоставления гибкого и простого в использовании интерфейса. Независимо от того, нужно ли вам генерировать структуру каталогов для документации, анализа или любых других целей, эта библиотека предлагает удобное решение.

Ссылки:

• Репозиторий GitHub
• PYPI пакет

---