Metadata-Version: 2.1
Name: viztree
Version: 0.2.0
Summary: Directory tree visualizer
Home-page: https://github.com/sky-joker/viztree
Author: sky-joker
Author-email: sky.jokerxx@gmail.com
Maintainer: sky-joker
Maintainer-email: sky.jokerxx@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/sky-joker/viztree/issues
Project-URL: Source Code, https://github.com/sky-joker/viztree
Keywords: tree
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: jinja2

# viztree

[![](https://img.shields.io/github/license/sky-joker/viztree?style=for-the-badge)](https://github.com/sky-joker/viztree/blob/main/LICENSE)

Viztree can generate an html for visualizing the directory tree.  
The directory tree is visualized with [Fancytree](https://github.com/mar10/fancytree).

![](images/sample.png)

# Requirements

* jinja2

# Installing

You can install viztree with pip.

```
$ pip install viztree
```

Or it is possible to install from GitHub repository.

```
$ pip install git+https://github.com/sky-joker/viztree.git
```

# Usage

The html file that has the directory tree does generate by executing the below command.

```
$ viztree
```

If you'd like to specify the directory to generate the tree, please specify the path in the argument of the command.

```
$ viztree some_directory
```

The skin can change by specifying the skin option.

```
$ viztree --skin lion
```

You can look at the visualized directory tree by opening the html file with your browser.


