Metadata-Version: 2.1
Name: SupaFileTree-SainitinD
Version: 0.0.1
Summary: A project that when given a folder path, generates a tree of all the files inside
Author-email: Sainitin Daverpally <s.daverpally@gmail.com>
Project-URL: Homepage, https://github.com/SainitinD/File-Tree-Generator
Project-URL: Issues, https://github.com/SainitinD/File-Tree-Generator/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# Supa File Tree

A project that when given a folder path, generates a tree of all the files inside it. I created this using pure python and its base packages.

I made it because I couldn't find any python packages that did this. I intend to publish it into pip soon (whenever their website allows me to)

# Project Output

I ran the program on a local copy of my [**tic-tac-toe**](https://github.com/SainitinD/Tic-Tac-Toe-with-GUI) project. Here is the generated output

```
├── assests
│   ├── null
│   │   └── null.png
│   ├── O_Assets
│   │   ├── O.png
│   │   ├── O_diag.png
│   │   ├── O_diag2.png
│   │   ├── O_hor.png
│   │   ├── O_hor2.png
│   │   ├── O_vert.png
│   │   └── O_vert2.png
│   ├── sounds
│   │   ├── Button_Sound.wav
│   │   └── license.txt
│   └── X_Assets
│       ├── X.png
│       ├── X_diag.png
│       ├── X_diag2.png
│       ├── X_hor.png
│       └── X_vert.png
├── ReadMe.txt
└── tic_tac_toe_GUI.py
```

# Run this project

Assuming the project is being run in _C:\Users\sample_, run it using the following ...

`python3 main.py "C:\Users\sample\SAMPLEPROJECT" --tg ".\" --o ".\"`

Where

```
"C:\Users\sample\SAMPLEPROJECT" is the input path (REQUIRED)

--tg ".\" refers to the location of the .treeignore file (OPTIONAL)
--o ".\" refers to the location of where you want to see the output file (OPTIONAL)
```

# How to not include some files in tree

Create `.treeignore` and add the file/folders you don't want to see in the tree
Then use `--tg PATH` and add the _PATH_ when running the file

Example `.treeignore` file

```
.git
.gitignore
```
