The Directory Content Documentation Generator (DCDG) is a Python-based tool designed to generate comprehensive documentation of directory structures and file contents. It allows users to filter and categorize files, making it easier to understand and document large directories.
- Generate HTML and text documentation of directory structures.
- Filter files and directories based on custom patterns.
- Support for regular expressions in file filtering.
- Multiple modes for flexible documentation generation.
- Easy-to-use graphical user interface for selecting directories and setting options.
- Python 3.x
- Additional Python packages:
tqdm,tkinter(usually included with Python)
Clone the repository to your local machine:
git clone https://github.com/dariuszwit/dcdg
cd [Name of Your Project Folder]
Install the required Python packages:
pip install tqdm
Run the install.bat
Run the script main.py to start the application:
python main.py
Follow the GUI prompts to select the input and output directories and set the desired mode of operation.
Contributions to the DCDG are welcome. Please follow these steps to contribute:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes.
- Submit a pull request with a clear description of your changes.
This project is licensed under the MIT License - see the LICENSE.md file for details.
- Dariusz Wit - Initial work
Special thanks to [here is space for you ;)].
Q: Can I use DCDG for commercial purposes? A: Yes, DCDG is licensed under the MIT License, allowing commercial use.
Q: Does DCDG support network drives? A: Currently, DCDG only supports local file systems.
For any inquiries, please contact [email protected].
- Project Repository: https://github.com/dariuszwit/dcdg
- Issue Tracker: [URL to Your Issue Tracker]