Add initial project structure with core functionality
This commit is contained in:
102
README.md
Normal file
102
README.md
Normal file
@@ -0,0 +1,102 @@
|
||||
# Renamer - Media File Renamer and Metadata Editor
|
||||
|
||||
A terminal-based (TUI) application for scanning directories, viewing media file details, and managing file metadata. Built with Python and Textual.
|
||||
|
||||
## Features
|
||||
|
||||
- Recursive directory scanning for video files
|
||||
- Tree view navigation with keyboard and mouse support
|
||||
- File details display (size, extensions, metadata)
|
||||
- Command-based interface with hotkeys
|
||||
- Container type detection using Mutagen
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
- Python 3.11+
|
||||
- UV package manager
|
||||
|
||||
### Install UV (if not already installed)
|
||||
```bash
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
```
|
||||
|
||||
### Install the Application
|
||||
```bash
|
||||
# Clone or download the project
|
||||
cd /path/to/renamer
|
||||
|
||||
# Install dependencies and build
|
||||
uv sync
|
||||
|
||||
# Install as a global tool
|
||||
uv tool install .
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Running the App
|
||||
```bash
|
||||
# Scan current directory
|
||||
renamer
|
||||
|
||||
# Scan specific directory
|
||||
renamer /path/to/media/directory
|
||||
```
|
||||
|
||||
### Commands
|
||||
- **q**: Quit the application
|
||||
- **o**: Open directory selection dialog
|
||||
- **s**: Rescan current directory
|
||||
|
||||
### Navigation
|
||||
- Use arrow keys to navigate the file tree
|
||||
- Mouse clicks supported
|
||||
- Select a video file to view its details in the right panel
|
||||
|
||||
## Development
|
||||
|
||||
### Setup Development Environment
|
||||
```bash
|
||||
# Install in development mode
|
||||
uv sync
|
||||
|
||||
# Run directly (development)
|
||||
uv run python main.py
|
||||
|
||||
# Or run installed version
|
||||
renamer
|
||||
```
|
||||
|
||||
### Running Without Rebuilding (Development)
|
||||
```bash
|
||||
# Run directly from source (no installation needed)
|
||||
uv run python main.py
|
||||
|
||||
# Or run with specific directory
|
||||
uv run python main.py /path/to/directory
|
||||
```
|
||||
|
||||
### Uninstall
|
||||
```bash
|
||||
uv tool uninstall renamerq
|
||||
```
|
||||
|
||||
## Supported Video Formats
|
||||
- .mkv
|
||||
- .avi
|
||||
- .mov
|
||||
- .mp4
|
||||
- .wmv
|
||||
- .flv
|
||||
- .webm
|
||||
- .m4v
|
||||
- .3gp
|
||||
- .ogv
|
||||
|
||||
## Dependencies
|
||||
- textual: TUI framework
|
||||
- mutagen: Media metadata detection
|
||||
|
||||
## License
|
||||
[Add license here]
|
||||
Reference in New Issue
Block a user