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パッケージ

---