The Directory Scanner is a Python library designed to simplify the process of scanning directory structures and generating a comprehensive list of files and folders. It provides a convenient way to recursively traverse directories, ignoring specific files and folders specified by the user.
Project description
The Directory Scanner
The Directory Scanner is a Python library designed to simplify the process of scanning directory structures and generating a comprehensive list of files and folders. It provides a convenient way to recursively traverse directories, ignoring specific files and folders specified by the user.
Features:
- Recursively scan directories and subdirectories to generate a structured list of files and folders.
- Exclude specific files and folders from the scan using an ignore list.
- Supports customization of the output format to suit different needs.
Usage:
-
Install the library using pip:
pip install the-directory-scanner
-
Import the
scan_directory
function from the library and use it to scan a 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__',))
-
Access the generated directory structure in the output file (
directory_structure.txt
in this example) to view the results. -
If you wish to modify the structure, import
prettify_structure
function and provide the path to generated file: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)
Output example directory_structure.txt
:
directory_structure.txt
LICENSE.rst
README.md
setup.py
usage.py
directory_scanner/
directory_structure.txt
main.py
__init__.py
About:
The Directory Scanner library aims to simplify directory scanning tasks by providing a flexible and easy-to-use interface. Whether you need to generate a directory structure for documentation, analysis, or any other purpose, this library offers a convenient solution.
Links:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for the-directory-scanner-1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f27ef029a7d8ddeecb11d9006e383951fe9dc6417ce51bece6dcd1b0b8eeee7b |
|
MD5 | abf29f86bcfefac182c791dfcb6bfd22 |
|
BLAKE2b-256 | 6022483e5e4522733c3cc65c9fbaedbc77845418fe66eb3e1956c553fcfea764 |