Metadata-Version: 2.1
Name: FileNet
Version: 1.0.3
Summary: A Python package for creating 2D, 3D vizulization of directory and files with their hierarchical relations.
Author: Aditya Narayan
Author-email: adityaan277@gmail.com
Description-Content-Type: text/markdown
Requires-Dist: networkx
Requires-Dist: matplotlib
Requires-Dist: plotly
Requires-Dist: scipy

# FileNet
FileNet is a library to visulaize your directories and files with their hierarchical relation in 2D or 3D.
## Installation

Use ```Python >= 3.12```

```bash
pip install FileNet
```
or
```bash
pip3 install FileNet
```

## Usage

### Using 2D visualization :

- <b><mark>draw2D</mark></b> take two arguments, ```'start_path'``` and ```'theme'```. ```'start_path'``` is mandatory argument and ```'theme'``` has a default value of ```'4'``` which can be changed between ```1``` to ```4```.

```python
import FileNet

FileNet.draw2D(start_path = "Replace with complete Root Directory Path", theme = 4)
```

### Using 3D visualization :

- <b><mark>draw3D</mark></b> takes only one argument ```start_path```.

```python
import FileNet

FileNet.draw3D(start_path = "Replace with complete Root Directory Path")
```

## Upcoming Improvements

- Saving 2D and 3D Images.
- Improving Performance of draw3D( ).
- Enhanced Customization
