HandyView

<p align="center"> <img src="icon_text.png" height=100> </p>

<div align="center"><b><a href="README.md">English</a> | <a href="README_CN.md">简体中文</a></b></div>

<div align="center">

</div> <div align="center">

🔻Executable files | 🔧Installation | 📕使用说明

</div>

HandyView is a handy image viewer for convenient viewing and comparing. It is developed with PyQt5.

---

Handy Series:    <img src="https://github.com/xinntao/HandyView/blob/master/icon.png" alt="HandyView Icon" width="36" height="36"> HandyView   <img src="https://github.com/xinntao/HandyFigure/blob/master/icon.png" alt="HandyFigure Icon" width="36" height="36"> HandyFigure   <img src="https://github.com/xinntao/HandyCrawler/blob/master/icon.png" alt="HandyCrawler Icon" width="36" height="36"> HandyCrawler   <img src="https://github.com/xinntao/HandyWriting/blob/master/icon.png" alt="HandyWriting Icon" width="36" height="36"> HandyWriting

🔧 Installation

<img src="https://upload.wikimedia.org/wikipedia/commons/8/8d/Windows_darkblue_2012.svg" alt="Windows" height="28">

1. Download the pre-compiled executable zip file from the release page.
2. Unzip the file
3. Set HandyView as the default image viewer, so that you can double-click the image to open HandyView.

<img src="https://user-images.githubusercontent.com/11482921/171234862-5a54e430-7c07-4976-9ac8-ce8dbf520a17.png" alt="MacOS" height="24">

1. Download the handyviewer.dmg from the release page and install.
2. If you fail to install the app, you may first need to disable gatekeeper first. You should be aware of the risk of disabling gatekeeper.
3. Set HandyView as the default image viewer (use cmd+i), so that you can double-click the image to open HandyView.

<img src="https://upload.wikimedia.org/wikipedia/commons/3/3a/Logo-ubuntu_no%28r%29-black_orange-hex.svg" alt="Ubuntu" height="24">

I used the early version of HandyView on Ubuntu. The current version is not tested on Ubuntu and may be out-of-date.

1. Clone this repo git clone https://github.com/xinntao/HandyView.git
2. How to double click to open an image
   1. Modify the HandyView.desktop file - Exec & Icon
   2. Copy the .desktop file to /usr/share/applications
3. How to change the default image viewer
   1. Right click an image
   2. Go to Properties -> Open With
   3. Choose HandyView

<img src="https://user-images.githubusercontent.com/11482921/171239036-858e2c00-835f-4278-afb4-5b8ac3fe2b65.png" alt="Ubuntu" height="38">

For python user, you can also launch HandyView from the command line:

1. Clone repo and install dependent packages

   git clone https://github.com/xinntao/HandyView.git
   cd HandyView
   pip install -r requirements.txt
   

2. Run

   python -m handyview.handyviewer [image_path]
   

:sparkles: Features

• Switch among images with fixed zoom ration, which is useful when comparing image details. (Unfortunately, I cannot find such a image viewer and this is the initial motivation to develop HandyView).
• Various comparison modes.
• Show basic image information, e.g., image path, shape, size, color type, zoom ration, etc.
• Show the position and color in the current mouse cursor.
• Draw rectangles on images and show the start and end position.

:eyes: Screenshot

• Current screenshot

<p align="center"> <img src="assets/screenshot.png" height="400"> </p>

• Switch among images with fixed zoom ratio

<p align="center"> <img src="assets/hv_switch.gif" height="400"> </p>

• Compare images in two-column or three-column modes

<p align="center"> <img src="assets/hv_cmp.gif" height="400"> </p>

• Show the position and color of the current mouse cursor

<p align="center"> <img src="assets/hv_mousemove.gif" height="400"> </p>

• Draw rectangles and show the start and end positions

<p align="center"> <img src="assets/hv_rect.gif" height="400"> </p>

Compile to executable program

For Windows and MacOS users, you can find the instructions of compiling the executable program from how-to-build.

:book: Document (On the way)

The basic operation (such as shortcut keys) could be found in the Help button in the toolbar.

:hourglass_flowing_sand: TODO list

• [ ] preview mode
• [ ] show zoom info for each folder (store in database)
• [ ] drag together in the multi-view comparison mode

Editing operation

• [ ] Simple image edit: crop, resize, color conversion, etc
• [ ] Draw rectangular and enlarged the area
• [ ] Make GIF easily

:books: References

• Qt5 doc
• PyQt5 doc
• Qt Key

:scroll: License and Acknowledgement

This project is released under the MIT license.

Icons

I have used the icons from flaticon. The following are the source links.

| Icon | Link | Icon | Link | Icon |Link| | :--- | :---: | :--- | :---: | :--- | :---: | | <img src="icons/open.png" height="32" alt="Open"> | Open | <img src="icons/history.png" height="32" alt="History">|History | <img src="icons/refresh.png" height="32" alt="Refresh"> |Refresh | | <img src="icons/index.png" height="32" alt="Index"> | Index | <img src="icons/include.png" height="32" alt="Include"> |Include | <img src="icons/exclude.png" height="32" alt="Exclude">|Exclude | | <img src="icons/compare.png" height="32" alt="Compare"> | Compare | <img src="icons/clear_comparison.png" height="32" alt="Clear comparison"> |Clear comparison |<img src="icons/instructions.png" height="32" alt="Help"> |Help| | <img src="icons/main_canvas.png" height="32" alt="Main canvas"> | Main canvas | <img src="icons/compare_canvas.png" height="32" alt="Compare canvas"> |Compare canvas | <img src="icons/preview_canvas.png" height="32" alt="Preview canvas"> |Preview canvas| | <img src="icons/fingerprint.png" height="32" alt="Fingerprint"> | Fingerprint | <img src="icons/auto_zoom.png" height="32" alt="auto zoom"> | Auto Zoom | | | | <img src="icons/image.png" height="32" alt="auto image"> | Image | <img src="icons/crop.png" height="32" alt="crop"> | Crop | <img src="icons/video.png" height="32" alt="video"> | Video |

(pip install pyqt5 -i http://mirrors.xxx.com/pypi/simple/ --trusted-host mirrors.xxx.com)

:e-mail: Contact

If you have any question, please open an issue or email xintao.wang@outlook.com.