kevinveenbirkenbach/directory-content-scanner
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/directory-content-scanner.git synced 2024-11-21 20:41:04 +01:00
Code Issues Packages Projects Releases Wiki Activity
16 Commits 1 Branch 0 Tags 69 KiB
Python 100%
4cd687052e
Go to file
Kevin Veen-Birkenbach 4cd687052e added detailed description
2023-12-16 18:30:01 +01:00
LICENSE Initial commit 2023-09-02 16:35:30 +02:00
README.md implemented string whitelist 2023-12-15 13:42:52 +01:00
scan.py added detailed description 2023-12-16 18:30:01 +01:00

README.md

Directory Content Scanner

The Directory Content Scanner is a Python-based utility designed to recursively scan directories, presenting both file paths and their content. It's an invaluable tool for in-depth content exploration and debugging within nested file structures.

🚀 Getting Started

📋 Prerequisites

  • Python 3.x

🛠️ Installation

  1. Clone the repository:

    git clone https://github.com/kevinveenbirkenbach/directory-content-scanner.git

  2. Navigate to the cloned directory:

    cd directory-content-scanner

📖 Usage

Run the Python script, specifying the target directory and any desired filters:

python3 scan.py /path/to/directory [options]

Options:

To show the help page execute:

python3 scan.py /path/to/directory --help

⚠️ Caution

Exercise caution when scanning directories with large files. The script may produce extensive output. Always assess the data volume before executing the script.

🤝 Contributing

Contributions via pull requests are welcome. For significant modifications, kindly open an issue first to discuss the proposed changes.

✍️ Author

Kevin Veen-Birkenbach

📜 License

This project is licensed under the GNU Affero General Public License v3.0. The complete license text is available in the LICENSE file.

🙏 Acknowledgements

Special thanks to OpenAI's ChatGPT model for assistance. Dive deeper into the creation process here and here.