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軟件包

---