Metadata-Version: 2.1
Name: DirecTracer
Version: 1.0.2
Summary: DirecTracer is a Python script that generates a directory structure in both text and Markdown formats. It can be used to visualize the hierarchy of folders and files in a given directory, while also excluding specific folders and file extensions.
Home-page: https://github.com/Hardvan/DirecTracer
Author: Hardik Pawar
Author-email: hardikpawarh@gmail.com
License: UNKNOWN
Keywords: directory structure,visualization,folder hierarchy,file organization
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# DirecTracer

DirecTracer is a Python script that generates a directory structure in both text and Markdown formats. It can be used to visualize the hierarchy of folders and files in a given directory, while also excluding specific folders and file extensions.

## Features

- Generates a directory structure in text and Markdown formats.
- Supports ignoring specific directories and file extensions.
- Outputs clickable links in the Markdown file for easy navigation.

## Usage

Clone this repository using the following command:

```bash
git clone https://github.com/Hardvan/DirecTracer
cd DirecTracer
pip install .
```

OR

Install the DirecTracer package using the following command:

```bash
pip install DirecTracer
```

Call the `save_directory_structure` function from the `DirecTracer` module to generate the directory structure.

```python
from DirecTracer import save_directory_structure
import os


# Generate the directory structure in text and Markdown formats
save_directory_structure(
   root_dir=os.getcwd(),
   text_output_file="directory_structure.txt",
   markdown_output_file="directory_structure.md",
   animation=True
)
```

The function accepts the following parameters:

- **root_dir (str):** The root directory to start scanning from.
- **text_output_file (str):** The name of the text output file.
- **markdown_output_file (str):** The name of the Markdown output file.
- **ignored_directories (list, optional):** List of directories to ignore. Defaults to None.
- **ignored_extensions (list, optional):** List of file extensions to ignore. Defaults to None.
- **animation (bool, optional):** Enable/Disable the loading animation. Defaults to False.


