Metadata-Version: 2.4
Name: folderlens
Version: 1.0.1
Summary: A modern file and folder navigation, management and search tool
Author-email: Frederick <wedonotuse@outlook.com>
License-Expression: GPL-3.0
Project-URL: Homepage, https://github.com/EasyCam/FolderLens
Project-URL: Repository, https://github.com/EasyCam/FolderLens.git
Project-URL: Issues, https://github.com/EasyCam/FolderLens/issues
Keywords: file,folder,browser,search,gui,qt,pyside
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Desktop Environment :: File Managers
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PySide6>=6.4.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# FolderLens

A modern file and folder navigation, management, and search tool built with PySide6 (Qt for Python).

![](images/01_Start.png)

## Features

- **File Browser**: Tree-based file browser with detailed information (name, type, modified date, size).
- **Async Size Calculation**: Folder sizes are calculated asynchronously in the background to keep the UI responsive.
- **Search & Filter**: Real-time search and filtering by file/folder name.
- **Multi-language Support**: Built-in support for English and Chinese.
- **Context Menu**: Right-click context menu for file operations (open, delete, copy path, etc.).
- **Cross-platform**: Works on Windows, macOS, and Linux.

## Installation

### From PyPI (Recommended)

You can install FolderLens directly from PyPI:

```bash
pip install folderlens
```

### From Source (Git)

To install the latest version from the source code:

1. Clone the repository:
   ```bash
   git clone https://github.com/EasyCam/FolderLens.git
   cd FolderLens
   ```

2. Install the package in editable mode:
   ```bash
   pip install -e .
   ```

   For development, you can install with development dependencies:
   ```bash
   pip install -e ".[dev]"
   ```

## Usage

### Command Line

After installation, you can run FolderLens from the command line:

```bash
folderlens
```

### Python Module

You can also run it as a Python module:

```bash
python -m folderlens
```

Or import it in your Python script:

```python
from folderlens.app import main
main()
```

## Screenshots

### Open Folder
![](images/02_OpenPath.png)

### Change Language
![](images/03_ChangeLang.png)

### Search
![](images/04_Search.png)

### Clear View
![](images/05_Clear.png)

## Requirements

- Python 3.8+
- PySide6 >= 6.4.0

## License

GPLv3 License
