folder-tree-generator 0.1.9

Takes a folder path and outputs a text representation of the folders and files, supports ignore files.

Folder Tree Generator

Folder Tree Generator is a Python module that takes a folder path and outputs a text representation of the folders and files. It supports ignore files, such as .gitignore, to exclude certain files or folders from the output.

typical string output:

my_project/
|-- .gitignore
|-- main.py
|-- utils.py
|-- data/
|   |-- input.txt
|   |-- output.txt

Why?

I needed a way to generate folder structures in a standard text format that I could copy and paste into GPT without including all the build artifacts, eg. repository structures for code analysis. If you wanted to make your own ignore file it should be a simple adapation of a gitignore file, in 90% of my use cases, the gitignore is sufficient.

Installation

You can install the module from PyPI using pip:

pip install folder-tree-generator

Usage

You can use the module as a command-line tool or import it in your Python script.

Command-line usage

python -m folder_tree_generator/folder_tree_generator /path/to/your/folder

Python script usage

from folder_tree_generator import generate_tree

output_text = generate_tree("/path/to/your/folder")
print(output_text)

Configuration

By default, the module looks for a .gitignore file in the root folder to determine which files and folders to ignore. You can change the ignore file name by passing an optional argument to the generate_tree function:

output_text = generate_tree("/path/to/your/folder", ignore_file_name=".myignore")

Development

To set up the development environment, clone the repository and install the required dependencies using Poetry:

git clone https://github.com/seandearnaley/folder-tree-generator.git
cd folder-tree-generator
poetry install

To run the tests, use the following command:

poetry run pytest

Make sure to update the README.md file with these changes.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue on the GitHub repository.

License

This project is licensed under the MIT License. See the LICENSE file for details.