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

---