[](#ENGLISH)
[](#ESPAÑOL)
___
# ENGLISH
## Overview
Treefolder is a simple Python program that generates an ASCII representation of a directory tree.
The function takes 2 parameters -i or -n and also the name of any folder that you want to ignore on the representation of the tree.
For example:
- `python tree.py -i sass images`: This will ignore all the base folders and also sass and images folder.
- `python tree.py -n .git`: This will ignore only the folder .git
** If installed using pip, the commands are `treefolder -i args` or `treefolder -n args`. **
## Features
- **Directory Tree Generation**: Creates an ASCII tree representation of a specified directory.
- **Ignore Folders**: Option to ignore specific folders or use a predefined list of common folders to ignore.
- **GUI Folder Selection**: Uses a graphical interface to select the folder to generate the tree for.
## How It Works
1. **Folder Selection**: Users select a folder using a graphical file dialog.
2. **Tree Generation**: The program generates an ASCII tree representation of the selected folder, optionally ignoring specified folders.
3. **Output**: The generated tree is printed to the console.
## Setup Instructions
### Prerequisites
- Python 3.x
- Required Python libraries: os, argparse, tkinter
### Installation
1. **Clone the repository**:
- `git clone https://github.com/Aperezortega/Treefolder.git`
- `cd treefolder`
- `pip install -r requirements.txt`
o
2. **Install from PyPI**:
- `pip install treefolder`
### Usage
1. **Run the script**:
- `python treefolder.py`
2. **Select a folder**: A file dialog will appear to select the folder.
3. **View the tree**: The ASCII tree representation will be printed in the console.
### Customization
- **Ignored Folders**: Modify the `base_ignored_folders` list in the script to add or remove default ignored folders.
- **Command Line Arguments**: Use `-i` or `--ignore` to specify additional folders to ignore, or `-n` or `--no-ignore` to specify folders to ignore exclusively.
___
# ESPAÑOL
## Descripción General
Treefolder es un programa simple en Python que genera una representación ASCII de un árbol de directorios. La función acepta 2 parámetros -i o -n y también el nombre de cualquier carpeta que desees ignorar en la representación del árbol.
Por ejemplo:
python tree.py -i sass images: Esto ignorará todas las carpetas base y también las carpetas sass e images.
python tree.py -n .git: Esto ignorará solo la carpeta .git.
** Si se installa usando pip los comandos serían treefolder -i args o treefolder -n args**
## Características
- **Generación de Árbol de Directorios**: Crea una representación en ASCII de un árbol de directorios especificado.
- **Ignorar Carpetas**: Opción para ignorar carpetas específicas o usar una lista predefinida de carpetas comunes para ignorar.
- **Selección de Carpeta con GUI**: Utiliza una interfaz gráfica para seleccionar la carpeta para generar el árbol.
## Cómo Funciona
1. **Selección de Carpeta**: Los usuarios seleccionan una carpeta usando un cuadro de diálogo de archivos gráfico.
2. **Generación de Árbol**: El programa genera una representación en ASCII del árbol de la carpeta seleccionada, ignorando opcionalmente las carpetas especificadas.
3. **Salida**: El árbol generado se imprime en la consola.
## Instrucciones de Configuración
### Requisitos Previos
- Python 3.x
- Bibliotecas de Python requeridas: os, argparse, tkinter
### Instalación
1. **Clone the repository**:
- `git clone https://github.com/Aperezortega/Treefolder.git`
- `cd treefolder`
- `pip install -r requirements.txt`
o
2. **Install from PyPI**:
- `pip install treefolder`
### Uso
1. **Ejecutar el script**:
- `python treefolder.py`
2. **Seleccionar una carpeta**: Aparecerá un cuadro de diálogo para seleccionar la carpeta.
3. **Ver el árbol**: La representación en ASCII del árbol se imprimirá en la consola.
### Personalización
- **Carpetas Ignoradas**: Modifique la lista `base_ignored_folders` en el script para agregar o eliminar carpetas ignoradas por defecto.
- **Argumentos de Línea de Comandos**: Use `-i` o `--ignore` para especificar carpetas adicionales a ignorar, o `-n` o `--no-ignore` para especificar carpetas a ignorar exclusivamente.
___
Raw data
{
"_id": null,
"home_page": "https://github.com/Aperezortega/Treefolder",
"name": "treefolder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Alberto Perez Ortega",
"author_email": "apo0106@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/54/22/49753de57ac438112d79e3748822a1622f6172f6e12879b09498056499b7/treefolder-1.0.0.tar.gz",
"platform": null,
"description": "[](#ENGLISH) \r\n[](#ESPA\u00d1OL)\r\n___\r\n\r\n# ENGLISH\r\n\r\n## Overview\r\n\r\nTreefolder is a simple Python program that generates an ASCII representation of a directory tree.\r\nThe function takes 2 parameters -i or -n and also the name of any folder that you want to ignore on the representation of the tree.\r\nFor example:\r\n - `python tree.py -i sass images`: This will ignore all the base folders and also sass and images folder.\r\n - `python tree.py -n .git`: This will ignore only the folder .git\r\n\r\n** If installed using pip, the commands are `treefolder -i args` or `treefolder -n args`. **\r\n\r\n## Features\r\n\r\n- **Directory Tree Generation**: Creates an ASCII tree representation of a specified directory.\r\n- **Ignore Folders**: Option to ignore specific folders or use a predefined list of common folders to ignore.\r\n- **GUI Folder Selection**: Uses a graphical interface to select the folder to generate the tree for.\r\n\r\n## How It Works\r\n\r\n1. **Folder Selection**: Users select a folder using a graphical file dialog.\r\n2. **Tree Generation**: The program generates an ASCII tree representation of the selected folder, optionally ignoring specified folders.\r\n3. **Output**: The generated tree is printed to the console.\r\n\r\n## Setup Instructions\r\n\r\n### Prerequisites\r\n\r\n- Python 3.x\r\n- Required Python libraries: os, argparse, tkinter\r\n\r\n### Installation\r\n\r\n1. **Clone the repository**:\r\n - `git clone https://github.com/Aperezortega/Treefolder.git`\r\n - `cd treefolder`\r\n - `pip install -r requirements.txt`\r\n\r\no\r\n\r\n2. **Install from PyPI**:\r\n - `pip install treefolder`\r\n\r\n### Usage\r\n\r\n1. **Run the script**:\r\n - `python treefolder.py`\r\n2. **Select a folder**: A file dialog will appear to select the folder.\r\n3. **View the tree**: The ASCII tree representation will be printed in the console.\r\n\r\n### Customization\r\n\r\n- **Ignored Folders**: Modify the `base_ignored_folders` list in the script to add or remove default ignored folders.\r\n- **Command Line Arguments**: Use `-i` or `--ignore` to specify additional folders to ignore, or `-n` or `--no-ignore` to specify folders to ignore exclusively.\r\n\r\n___\r\n\r\n# ESPA\u00d1OL\r\n\r\n## Descripci\u00f3n General\r\n\r\nTreefolder es un programa simple en Python que genera una representaci\u00f3n ASCII de un \u00e1rbol de directorios. La funci\u00f3n acepta 2 par\u00e1metros -i o -n y tambi\u00e9n el nombre de cualquier carpeta que desees ignorar en la representaci\u00f3n del \u00e1rbol. \r\nPor ejemplo:\r\npython tree.py -i sass images: Esto ignorar\u00e1 todas las carpetas base y tambi\u00e9n las carpetas sass e images.\r\npython tree.py -n .git: Esto ignorar\u00e1 solo la carpeta .git.\r\n\r\n** Si se installa usando pip los comandos ser\u00edan treefolder -i args o treefolder -n args**\r\n\r\n## Caracter\u00edsticas\r\n\r\n- **Generaci\u00f3n de \u00c1rbol de Directorios**: Crea una representaci\u00f3n en ASCII de un \u00e1rbol de directorios especificado.\r\n- **Ignorar Carpetas**: Opci\u00f3n para ignorar carpetas espec\u00edficas o usar una lista predefinida de carpetas comunes para ignorar.\r\n- **Selecci\u00f3n de Carpeta con GUI**: Utiliza una interfaz gr\u00e1fica para seleccionar la carpeta para generar el \u00e1rbol.\r\n\r\n## C\u00f3mo Funciona\r\n\r\n1. **Selecci\u00f3n de Carpeta**: Los usuarios seleccionan una carpeta usando un cuadro de di\u00e1logo de archivos gr\u00e1fico.\r\n2. **Generaci\u00f3n de \u00c1rbol**: El programa genera una representaci\u00f3n en ASCII del \u00e1rbol de la carpeta seleccionada, ignorando opcionalmente las carpetas especificadas.\r\n3. **Salida**: El \u00e1rbol generado se imprime en la consola.\r\n\r\n## Instrucciones de Configuraci\u00f3n\r\n\r\n### Requisitos Previos\r\n\r\n- Python 3.x\r\n- Bibliotecas de Python requeridas: os, argparse, tkinter\r\n\r\n### Instalaci\u00f3n\r\n\r\n1. **Clone the repository**:\r\n - `git clone https://github.com/Aperezortega/Treefolder.git`\r\n - `cd treefolder`\r\n - `pip install -r requirements.txt`\r\n\r\no\r\n\r\n2. **Install from PyPI**:\r\n - `pip install treefolder`\r\n\r\n### Uso\r\n\r\n1. **Ejecutar el script**:\r\n - `python treefolder.py`\r\n2. **Seleccionar una carpeta**: Aparecer\u00e1 un cuadro de di\u00e1logo para seleccionar la carpeta.\r\n3. **Ver el \u00e1rbol**: La representaci\u00f3n en ASCII del \u00e1rbol se imprimir\u00e1 en la consola.\r\n\r\n### Personalizaci\u00f3n\r\n\r\n- **Carpetas Ignoradas**: Modifique la lista `base_ignored_folders` en el script para agregar o eliminar carpetas ignoradas por defecto.\r\n- **Argumentos de L\u00ednea de Comandos**: Use `-i` o `--ignore` para especificar carpetas adicionales a ignorar, o `-n` o `--no-ignore` para especificar carpetas a ignorar exclusivamente.\r\n\r\n___\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple Python program that generates an ASCII representation of a directory tree.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Aperezortega/Treefolder"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4987349debd818137c07cfb36dd7284b8ff73b9c8681bb519d30b7d54d9bb3a",
"md5": "8189eb7a6559df62b0eab9ebf3e70992",
"sha256": "14b0110c17e5b7b4b79c0cf7c3161214429bc4b7b9ec690e1beec1b7ce0a5046"
},
"downloads": -1,
"filename": "treefolder-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8189eb7a6559df62b0eab9ebf3e70992",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 16652,
"upload_time": "2024-09-02T12:32:40",
"upload_time_iso_8601": "2024-09-02T12:32:40.837780Z",
"url": "https://files.pythonhosted.org/packages/c4/98/7349debd818137c07cfb36dd7284b8ff73b9c8681bb519d30b7d54d9bb3a/treefolder-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "542249753de57ac438112d79e3748822a1622f6172f6e12879b09498056499b7",
"md5": "cf3738b63ebb2c83019d16160f55cdd7",
"sha256": "86024af1ead41018cd32555a0949c4ddd83bacb3e107b32a81c259f1476dd5ba"
},
"downloads": -1,
"filename": "treefolder-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "cf3738b63ebb2c83019d16160f55cdd7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16460,
"upload_time": "2024-09-02T12:32:42",
"upload_time_iso_8601": "2024-09-02T12:32:42.247190Z",
"url": "https://files.pythonhosted.org/packages/54/22/49753de57ac438112d79e3748822a1622f6172f6e12879b09498056499b7/treefolder-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 12:32:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Aperezortega",
"github_project": "Treefolder",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "treefolder"
}
JSON
