the directory scanner

Der Verzeichnisscanner

Der Verzeichnisscanner ist eine Python -Bibliothek, mit der der Prozess der Scan -Verzeichnisstrukturen und eine umfassende Liste von Dateien und Ordnern generiert wird. Es bietet eine bequeme Möglichkeit, Verzeichnisse rekursiv zu durchqueren und bestimmte Dateien und Ordner zu ignorieren, die vom Benutzer angegeben wurden.

Merkmale:

• Scannen Sie rekursiv Verzeichnisse und Unterverzeichnisse, um eine strukturierte Liste von Dateien und Ordnern zu generieren.
• Spezifische Dateien und Ordner aus dem Scan mit einer Ignorierliste ausschließen.
• Unterstützt die Anpassung des Ausgangsformats an unterschiedliche Anforderungen.

Verwendung:

1. Installieren Sie die Bibliothek mit PIP:

    pip install the-directory-scanner
   

2. Importieren Sie die Funktion scan_directory aus der Bibliothek und scannen Sie sie zum Scannen eines Verzeichnisses:

    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. Greifen Sie in der Ausgabedatei ( directory_structure.txt ) auf die generierte Verzeichnisstruktur zu, um die Ergebnisse anzuzeigen.

4. Wenn Sie die Struktur ändern möchten, importieren Sie die Funktion prettify_structure und geben Sie den Pfad zur generierten Datei an:

    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 )

---

Ausgabe Beispiel directory_structure.txt :

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

---

Um:

Die Verzeichnis-Scanner-Bibliothek zielt darauf ab, das Verzeichnis-Scan-Aufgaben zu vereinfachen, indem eine flexible und benutzerfreundliche Oberfläche bereitgestellt wird. Unabhängig davon, ob Sie eine Verzeichnisstruktur für Dokumentation, Analyse oder einen anderen Zweck generieren müssen, bietet diese Bibliothek eine bequeme Lösung.

Links:

• Github -Repository
• PYPI -Paket

---