Skip to content

Commit b5498fe

Browse files
Update README.md
1 parent db09bad commit b5498fe

File tree

1 file changed

+136
-1
lines changed

1 file changed

+136
-1
lines changed

README.md

Lines changed: 136 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,137 @@
11
# PyPixPro
2-
PyPixPro – A Python-powered photo organizer that sorts, renames, and verifies images using metadata and checksums. Supports HEIC, JPEG, PNG, raw formats, and more with seamless macOS integration.
2+
3+
PyPixPro is an automated image sorting and renaming tool for macOS. It leverages Python’s powerful libraries to sort images based on orientation, correct image metadata, and organize your folders efficiently. This tool supports multiple file types, including JPEG, PNG, HEIC, and raw image formats, and it even generates checksums for verification.
4+
5+
---
6+
7+
## Table of Contents
8+
9+
1. [Overview](#overview)
10+
2. [Features](#features)
11+
3. [How It Works](#how-it-works)
12+
4. [Installation](#installation)
13+
5. [Usage](#usage)
14+
6. [File Types Supported](#file-types-supported)
15+
7. [Advanced Configuration](#advanced-configuration)
16+
8. [Troubleshooting](#troubleshooting)
17+
9. [Contributing](#contributing)
18+
10. [License](#license)
19+
11. [Contact](#contact)
20+
21+
---
22+
23+
## Overview
24+
25+
PyPixPro simplifies the process of managing and sorting images. It organizes photos into Portrait and Landscape folders, handles HEIC files, generates checksums, and renames files with customizable prefixes. This tool aims to keep your photo library neat, with minimal manual intervention.
26+
27+
---
28+
29+
## Features
30+
31+
- **Automated Sorting**: Categorize images into Portrait, Landscape, Screenshots, or Misc folders.
32+
- **Metadata Correction**: Fix image orientation using EXIF metadata.
33+
- **HEIC Support**: Process HEIC and HEIF images seamlessly.
34+
- **Checksum Generation**: Verify file integrity using SHA-256 checksums.
35+
- **Custom Prefixes**: Rename files with user-defined prefixes for better organization.
36+
- **Cross-format Handling**: Sorts raw images, videos, and even documents.
37+
- **Error Handling**: Continues processing even if some files encounter errors.
38+
- **macOS Integration**: Uses `osascript` for user prompts and alerts.
39+
40+
---
41+
42+
## How It Works
43+
44+
1. **Input Folder Selection**: The user provides a folder via drag-and-drop or command-line input.
45+
2. **Checksum Generation**: SHA-256 checksums are generated to ensure data integrity.
46+
3. **Sorting Process**:
47+
- **Portrait vs. Landscape**: Images are sorted based on their orientation.
48+
- **Screenshots & Miscellaneous Files**: Specific file types are moved to dedicated folders.
49+
4. **File Renaming**: Files in the Portrait and Landscape folders are renamed with custom prefixes.
50+
5. **Completion Alert**: A macOS alert notifies the user when the process finishes.
51+
52+
---
53+
54+
## Installation
55+
56+
1. **Install Python 3** (if not already installed).
57+
- Use Homebrew:
58+
```bash
59+
brew install python
60+
```
61+
62+
2. **Install Dependencies**:
63+
```bash
64+
pip install pillow pyheif
65+
```
66+
67+
---
68+
69+
## Usage
70+
71+
### Basic Usage
72+
73+
1. **Drag and Drop**: Drop a folder onto the PyPixPro droplet to start the process.
74+
2. **Command-Line Usage**:
75+
```bash
76+
python3 PyPixPro.py /path/to/your/folder
77+
```
78+
79+
---
80+
81+
## File Types Supported
82+
83+
- **Standard Images**: `.jpg`, `.jpeg`, `.png`, `.gif`, `.bmp`, `.tiff`, `.webp`, etc.
84+
- **HEIC/HEIF Files**: `.heic`, `.heif`
85+
- **Raw Image Formats**: `.dng`, `.nef`, `.cr2`, `.arw`, etc.
86+
- **Miscellaneous Files**: `.txt`, `.pdf`, `.mp4`, `.mov`, etc.
87+
88+
---
89+
90+
## Advanced Configuration
91+
92+
- **Modify Folder Names**: Adjust the constants in the code to change folder names.
93+
- **Add New File Types**: Extend supported file types by editing the `STANDARD_IMAGE_EXTENSIONS` or `MISC_EXTENSIONS` constants.
94+
- **Error Handling**: The script gracefully skips files with issues, printing errors for reference.
95+
96+
---
97+
98+
## Troubleshooting
99+
100+
- **HEIC Files Not Processed**: Ensure `pyheif` is installed via pip.
101+
- **Permission Errors**: Check if you have the necessary permissions for the input folder.
102+
- **EXIF Metadata Issues**: Some images might not contain correct orientation metadata.
103+
- **Slow Performance**: This can happen with large datasets—try excluding large files.
104+
105+
---
106+
107+
## Contributing
108+
109+
We welcome contributions to improve PyPixPro! Here’s how you can help:
110+
111+
1. **Fork the Repository** on GitHub.
112+
2. **Create a Feature Branch**:
113+
```bash
114+
git checkout -b feature/AmazingFeature
115+
```
116+
3. **Commit Your Changes**:
117+
```bash
118+
git commit -m "Add some AmazingFeature"
119+
```
120+
4. **Push to the Branch**:
121+
```bash
122+
git push origin feature/AmazingFeature
123+
```
124+
5. **Open a Pull Request**: Submit your changes for review.
125+
126+
---
127+
128+
## License
129+
130+
This project is licensed under the **MIT License**. See the [LICENSE.md](LICENSE.md) file for more information.
131+
132+
---
133+
134+
## Contact
135+
136+
Your Name – [[email protected]](mailto:[email protected])
137+
Project Link: [GitHub](https://github.com/RazorBackRoar/PyPixPro)

0 commit comments

Comments
 (0)