CTKFileDialog-plus 0.3.0__tar.gz

ctkfiledialog_plus-0.3.0/CTKFileDialog_plus.egg-info/PKG-INFO

@@ -0,0 +1,343 @@
+Metadata-Version: 2.4
+Name: CTKFileDialog-plus
+Version: 0.3.0
+Summary: A modern file dialog for CustomTkinter
+Home-page: https://github.com/hmidani-abdelilah/CTkFileDialog-plus
+Author: abdelilah
+Author-email: abdelilah <hmidaniabdelilah92@gmail.com>
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: customtkinter
+Requires-Dist: Pillow
+Requires-Dist: opencv-python
+Requires-Dist: CTkMessagebox
+Requires-Dist: CTkToolTip
+Requires-Dist: typeguard
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-python
+
+<h1 align="center">CTkFileDialog</h1>
+
+<h3 align="center">A modern and fully customizable File Dialog for CustomTkinter — a must-have extension pack!</h3>
+
+> [!WARNING]
+> Unfortunately parameters like `video_preview`, `preview_img`, and `tooltip` are not compatible with the mini dialog and will not be applied. View modes and sorting are exclusive to the Default dialog.
+
+---
+
+## 🚀 Features
+
+- 🔍 Autocomplete in the path entry field (with `Tab`, `Up`, and `Down`)
+- � Search/filter files in real-time
+- 🖼️ Live image preview
+- 🎥 Video thumbnail preview
+- 📁 Directory selection
+- 💾 Save file dialog (return path or open file)
+- ❔ Tooltip support
+- 🖥️ Shell Path Syntax Support
+- ⌨️ Backspace using Alt + Left Arrow shortcut
+- 👀 Multiple view modes (Grid and List view in Default dialog)
+- 📊 Sort files by name, date, size, type, or last modified
+- 💡 Data type validation at runtime and for static type analyzers
+
+---
+
+## 📦 Installation
+
+```bash
+
+# Using bash 
+git clone https://github.com/hmidani-abdelilah/CTkFileDialog-plus
+cd CTkFileDialog-plus
+python3 -m venv .venv
+source .venv/bin/activate
+pip3 install -r requirements.txt
+
+# On Windows 
+git clone https://github.com/hmidani-abdelilah/CTkFileDialog-plus 
+cd CTkFileDialog-plus
+python3 -m venv .venv 
+.\.venv\Scripts\activate.ps1 # In Powershell
+pip3 install -r requirements.txt 
+
+# Or ussing pip 
+
+python3 -m venv .venv 
+source .venv/bin/activate # In powershell -> .\.venv\Scripts\activate.ps1
+pip3 install CTkFileDialog-plus
+
+```
+
+> [!WARNING]
+> You should install the [Hack Nerd Fonts](https://github.com/ryanoasis/nerd-fonts/releases/download/v3.2.1/Hack.zip) if u wanna see the icons without problems :) 
+
+---
+
+## 🧪 Demo — All Methods
+
+### 🗂️ Open File
+
+```python
+import customtkinter as ctk
+from CTkFileDialog import askopenfilename
+
+ctk.set_appearance_mode("Dark")
+ctk.set_default_color_theme("blue")
+
+def open_file():
+    path = askopenfilename(preview_img=True, autocomplete=True)
+    if path:
+        result_label.configure(text=f"Selected file:\n{path}")
+
+app = ctk.CTk()
+app.title("askopenfilename Demo")
+app.geometry("500x200")
+
+ctk.CTkButton(app, text="Open File", command=open_file).pack(pady=20)
+result_label = ctk.CTkLabel(app, text="Waiting for file selection...")
+result_label.pack()
+
+app.mainloop()
+```
+
+---
+
+### 🗂️ Open Multiple Files
+
+
+```python
+import customtkinter as ctk
+from CTkFileDialog import askopenfilenames
+
+ctk.set_appearance_mode("Dark")
+ctk.set_default_color_theme("blue")
+
+def open_files():
+    paths = askopenfilenames(preview_img=True, autocomplete=True)
+    if paths:
+        result_label.configure(text="Selected files:\n" + "\n".join(paths))
+
+app = ctk.CTk()
+app.title("askopenfilenames Demo")
+app.geometry("500x300")
+
+ctk.CTkButton(app, text="Open Multiple Files", command=open_files).pack(pady=20)
+result_label = ctk.CTkLabel(app, text="Waiting for file selection...", wraplength=450)
+result_label.pack()
+
+app.mainloop()
+```
+
+---
+
+### 📁 Select Directory
+
+```python
+import customtkinter as ctk
+from CTkFileDialog import askdirectory
+
+ctk.set_appearance_mode("Dark")
+ctk.set_default_color_theme("blue")
+
+def select_directory():
+    folder = askdirectory(autocomplete=True)
+    if folder:
+        result_label.configure(text=f"Selected directory:\n{folder}")
+
+app = ctk.CTk()
+app.title("askdirectory Demo")
+app.geometry("500x200")
+
+ctk.CTkButton(app, text="Select Directory", command=select_directory).pack(pady=20)
+result_label = ctk.CTkLabel(app, text="Waiting for directory selection...")
+result_label.pack()
+
+app.mainloop()
+```
+
+---
+
+### 💾 Save As (get path only)
+
+```python
+import customtkinter as ctk
+from CTkFileDialog import asksaveasfilename
+
+ctk.set_appearance_mode("Dark")
+ctk.set_default_color_theme("blue")
+
+def save_as_filename():
+    path = asksaveasfilename(autocomplete=True)
+    if path:
+        result_label.configure(text=f"Save file as:\n{path}")
+
+app = ctk.CTk()
+app.title("asksaveasfilename Demo")
+app.geometry("500x200")
+
+ctk.CTkButton(app, text="Save As (Filename Only)", command=save_as_filename).pack(pady=20)
+result_label = ctk.CTkLabel(app, text="Waiting for filename...")
+result_label.pack()
+
+app.mainloop()
+```
+
+---
+
+### 💾 Save As (write to file)
+
+```python
+import customtkinter as ctk
+from CTkFileDialog import asksaveasfile
+
+ctk.set_appearance_mode("Dark")
+ctk.set_default_color_theme("blue")
+
+def save_as_file():
+    file = asksaveasfile(autocomplete=True)
+    if file:
+        file.write("This file was created using the demo.")
+        file.close()
+        result_label.configure(text=f"File saved:\n{file.name}")
+
+app = ctk.CTk()
+app.title("asksaveasfile Demo")
+app.geometry("500x200")
+
+ctk.CTkButton(app, text="Save As (Real File)", command=save_as_file).pack(pady=20)
+result_label = ctk.CTkLabel(app, text="Waiting for save location...")
+result_label.pack()
+
+app.mainloop()
+```
+---
+
+## 🧩 Parameters
+
+<div align="center">
+
+| Parameter       | Description                                                                 |
+|----------------|-----------------------------------------------------------------------------|
+| `hidden`        | Show hidden files or directories (`False` by default).                     |
+| `preview_img`   | Enable image preview in the file dialog.                                   |
+| `video_preview` | Show first frame of video files as thumbnail (experimental).               |
+| `autocomplete`  | Enable path autocompletion with `Tab`, `Up`, and `Down`.                   |
+| `initial_dir`   | Set the initial directory when opening the dialog.                         |
+| `tool_tip`   | Enable the tool tip.                         |
+| `style`   | Defines the dialog style, by default it will be 'Default' but you can choose a small one ('Mini')                        |
+| `geometry`   | You define the geometry string in a tuple: Example ('NormalGM', 'MiniGeometry')                        |
+| `title`   | Define the title from the app, default will be "CTkFileDialog"                        |
+
+
+</div>
+
+---
+
+## 🌙 Dark Mode Preview
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hmidani-abdelilah/CTkFileDialog-plus/refs/heads/main/Images/NormalDialogDark.png" width="80%">
+</p>
+
+## ☀️ Light Mode Preview
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hmidani-abdelilah/CTkFileDialog-plus/refs/heads/main/Images/NormalDialogLight.png" width="80%">
+</p>
+
+---
+
+## 🎯 Using New Features
+
+### 🔎 Search/Filter Files
+Both Default and Mini dialogs include a search bar. Simply type in the search field to filter files and directories in real-time:
+```python
+file = askopenfilename(style='Default')
+# Use the search bar in the dialog to filter results
+```
+
+### 👀 View Modes (Default Dialog Only)
+The Default dialog supports two view modes:
+- **Grid View**: Icon-based grid layout (default)
+- **List View**: Detailed list with file info (size, date modified, type)
+
+Toggle between modes using the view buttons in the toolbar.
+
+### 📊 Sorting Options (Default Dialog Only)
+Sort files by:
+- Name (alphabetical)
+- Date (creation/modification time)
+- Type (file extension)
+- Size (file size)
+- Last Modified (most recent first)
+
+Select a sort option from the sort menu in the toolbar.
+
+--- 
+
+This module has constants that can be used outside or inside the dialog, they are used to obtain paths like /home/user or /home/user/.config/
+Here is a basic example
+
+```python3 
+#!/usr/bin/env python3 
+import customtkinter as ctk 
+from CTkFileDialog import askopenfilename
+from CTkFileDialog.Constants import HOME
+
+root = ctk.CTk()
+
+def open_file(): 
+    f = askopenfilename(initial_dir=HOME, autocomplete=True)
+    if f: 
+        print(f"file selected: {f}")
+
+ctk.CTkButton(master=root, command=open_file, text="Open File").pack(padx=10, pady=10, anchor=ctk.CENTER)
+
+root.mainloop()
+```
+
+## And here are the constants available from the package
+
+<div align="center">
+
+
+| Parameter       | Description                                                                 |
+|----------------|-----------------------------------------------------------------------------|
+| `PWD`        | Current working directory (e.g., where the program was launched)                     |
+| `HOME`   | User's home directory (e.g., /home/user or C:\Users\user)                               |
+| `TEMP` | Temporary directory (fallback to /tmp if no env vars are set)               |
+| `CONFIG_DIR`  | XDG-compliant user configuration directory (default: ~/.config)                   |
+| `CACHE_DIR`   | XDG-compliant user cache directory (default: ~/.cache)                       |
+| `PATH`   | System PATH split into a list of directories                         |
+| `DATA_DIR`   | XDG-compliant user data directory (default: ~/.local/share)                        |
+| `VENV`   | Active Python virtual environment (venv or conda), fallback to PWD                        |
+
+
+</div>
+
+--- 
+
+## Mini Dialog 
+
+This is a parameter of the file dialog, but it's more powerful than the default one. As I mentioned earlier, it doesn't support parameters like tooltip, preview_img, or video_preview.
+
+## 🌙 Dark Mode Preview
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hmidani-abdelilah/CTkFileDialog-plus/refs/heads/main/Images/MiniDialogDark.png" width="80%">
+</p>
+
+## ☀️ Light Mode Preview
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hmidani-abdelilah/CTkFileDialog-plus/refs/heads/main/Images/MiniDialogLight.png" width="80%">
+</p>
+
+The mini design  created by [user](https://github.com/limafresh), and the default design created by [user](https://github.com/SelfDreamer) and all credit goes to them. I also want to thank them for creating that design in advance.
+
+## I translate the code to English and add this futures: 
+
+- � Search/filter files in real-time
+- 👀 Multiple view modes (Grid and List view in Default dialog)
+- 📊 Sort files by name, date, size, type, or last modified

ctkfiledialog_plus-0.3.0/CTKFileDialog_plus.egg-info/SOURCES.txt

@@ -0,0 +1,34 @@
+MANIFEST.in
+README.md
+pyproject.toml
+setup.py
+CTKFileDialog_plus.egg-info/PKG-INFO
+CTKFileDialog_plus.egg-info/SOURCES.txt
+CTKFileDialog_plus.egg-info/dependency_links.txt
+CTKFileDialog_plus.egg-info/requires.txt
+CTKFileDialog_plus.egg-info/top_level.txt
+CTkFileDialog/Dialog.py
+CTkFileDialog/__init__.py
+CTkFileDialog/_functions.py
+CTkFileDialog/_system.py
+CTkFileDialog/Constants/__init__.py
+CTkFileDialog/Constants/constants.py
+CTkFileDialog/icons/bash.png
+CTkFileDialog/icons/conf.png
+CTkFileDialog/icons/css.png
+CTkFileDialog/icons/exe.png
+CTkFileDialog/icons/folder.png
+CTkFileDialog/icons/gz.png
+CTkFileDialog/icons/html.png
+CTkFileDialog/icons/image.png
+CTkFileDialog/icons/ini.png
+CTkFileDialog/icons/javascript.png
+CTkFileDialog/icons/js.png
+CTkFileDialog/icons/json.png
+CTkFileDialog/icons/markdown.png
+CTkFileDialog/icons/odt.png
+CTkFileDialog/icons/pdf.png
+CTkFileDialog/icons/php.png
+CTkFileDialog/icons/python.png
+CTkFileDialog/icons/text.png
+CTkFileDialog/icons/video.png

ctkfiledialog_plus-0.3.0/CTKFileDialog_plus.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ctkfiledialog_plus-0.3.0/CTKFileDialog_plus.egg-info/requires.txt

@@ -0,0 +1,6 @@
+customtkinter
+Pillow
+opencv-python
+CTkMessagebox
+CTkToolTip
+typeguard

ctkfiledialog_plus-0.3.0/CTKFileDialog_plus.egg-info/top_level.txt

@@ -0,0 +1 @@
+CTkFileDialog

ctkfiledialog_plus-0.3.0/CTkFileDialog/Constants/__init__.py

@@ -0,0 +1,37 @@
+"""
+This module is part of the CTkFileDialog library.
+
+It defines system path constants that point to useful directories such as the 
+user's home, config, cache, and data folders, as well as the system PATH and temp directory.
+
+These constants follow the XDG Base Directory Specification where possible,
+and serve as a utility for file dialogs and other filesystem operations within the library.
+
+Available constants:
+
+- PWD:        Current working directory where the program was launched.
+- HOME:       User's home directory.
+- TEMP:       Temporary directory, resolved from common environment variables or defaulting to /tmp.
+- CONFIG_DIR: XDG-compliant user configuration directory (e.g., ~/.config).
+- CACHE_DIR:  XDG-compliant user cache directory (e.g., ~/.cache).
+- DATA_DIR:   XDG-compliant user data directory (e.g., ~/.local/share).
+- PATH:       List of directories in the system PATH environment variable.
+- VENV:       Path to the active Python virtual environment (VIRTUAL_ENV or CONDA_PREFIX).
+
+Author: Flick
+Repository: https://github.com/FlickGMD/CTkFileDialog
+"""
+
+from .constants import PWD, HOME, PATH, TEMP, CONFIG_DIR, CACHE_DIR, DATA_DIR, VENV, PATHS
+
+__all__ = [
+        'PWD',
+        'HOME',
+        'PATH',
+        'TEMP',
+        'CACHE_DIR',
+        'CONFIG_DIR',
+        'DATA_DIR',
+        'VENV',
+        'PATHS',
+        ]

ctkfiledialog_plus-0.3.0/CTkFileDialog/Constants/constants.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+from pathlib import Path
+import os
+
+# Current working directory (e.g., where the program was launched)
+PWD = str(Path.cwd())
+
+# User's home directory (e.g., /home/user or C:\Users\user)
+HOME = str(Path.home())
+
+# System PATH split into a list of directories
+PATH = os.getenv('PATH').split(os.pathsep)
+
+# Temporary directory (fallback to /tmp if no env vars are set)
+TEMP = os.getenv('TMPDIR') or os.getenv('TEMP') or os.getenv('TMP') 
+
+# XDG-compliant user configuration directory (default: ~/.config)
+CONFIG_DIR = os.getenv('XDG_CONFIG_HOME', str(Path(HOME) / '.config'))
+
+# XDG-compliant user cache directory (default: ~/.cache)
+CACHE_DIR = os.getenv('XDG_CACHE_HOME', str(Path(HOME) / '.cache'))
+
+# XDG-compliant user data directory (default: ~/.local/share)
+DATA_DIR = os.getenv('XDG_DATA_HOME', str(Path(HOME) / '.local' / 'share'))
+
+# Active Python virtual environment (venv or conda), fallback to PWD 
+VENV = os.getenv("VIRTUAL_ENV") or os.getenv("CONDA_PREFIX") or PWD
+
+# All paths in a single dictionary for easy access
+PATHS = {
+    "HOME": HOME,
+    "PWD": PWD,
+    "TEMP": TEMP,
+    "CONFIG_DIR": CONFIG_DIR,
+    "DATA_DIR": DATA_DIR,
+    "CACHE_DIR": CACHE_DIR,
+    "PATH": PATH, 
+    'VENV': VENV
+}