Metadata-Version: 2.4
Name: dirtreemap
Version: 0.1.0
Summary: Directory treemap visualization tool using Plotly
Author: Greg Elphick
License: MIT License
        
        Copyright (c) 2025 Greg Elphick
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/elphick/dirtreemap
Project-URL: Repository, https://github.com/elphick/dirtreemap
Project-URL: Issues, https://github.com/elphick/dirtreemap/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: plotly
Requires-Dist: pandas
Requires-Dist: tqdm>=4.67.1
Dynamic: license-file

# dirtreemap
Directory treemap visualization tool using Plotly

## Installation
You can install the package via pip:

```bash
pip install dirtreemap
```
## Usage
You can use the `dirtreemap` command in your terminal to generate a treemap visualization of a directory. For example:
```bash
dirtreemap /path/to/directory /path/to/output_dir --report-filename treemap.html
```
This will create an HTML file with the treemap visualization of the specified directory.
You can also customize the visualization using various options. For a full list of options, run:
```bash
dirtreemap --help
```
> **Note**
>
> A log file named `dirtreemap.log` will be created in the specified output directory to record scan and generation details.

## Example
Here's an example of how to use `dirtreemap` in a Python script:
```python
import os
from pathlib import Path

from directory_treemap import DirectoryTreemap

scan_dir: Path = Path(os.path.expanduser("~"))

dtm: DirectoryTreemap = DirectoryTreemap(base_path=scan_dir,
                                         output_dir=Path("."),
                                         parallel=False)
dtm.scan()
dtm.generate_treemap(title='Demo Directory Treemap',
                     max_depth=4,
                     max_files=25)
dtm.save_report()
dtm.open_report()
```
This will generate a treemap visualization of the specified directory and save it as `treemap.html`

## Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub.

## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details
