Metadata-Version: 2.1
Name: labelimgplusplus
Version: 2.0.0
Summary: labelImg++ is an enhanced graphical image annotation tool with Gallery Mode for browsing and labeling images
Author-email: Abhik Sarkar <abhiksark@gmail.com>
License: Copyright (c) <2015-Present> Tzutalin
        
        Copyright (C) 2013  MIT, Computer Science and Artificial Intelligence Laboratory. Bryan Russell, Antonio Torralba, William T. Freeman
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/abhiksark/labelImg-plus-plus
Project-URL: Repository, https://github.com/abhiksark/labelImg-plus-plus
Keywords: labelImg,labelImgPlusPlus,annotation,deeplearning,image-annotation,bounding-box,gallery
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
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: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pyqt5
Requires-Dist: lxml

============
labelImg++
============

*A modern, enhanced image annotation tool for machine learning*

.. image:: https://img.shields.io/pypi/v/labelImgPlusPlus.svg
        :target: https://pypi.org/project/labelImgPlusPlus/

.. image:: https://img.shields.io/pypi/dm/labelImgPlusPlus.svg
        :target: https://pypi.org/project/labelImgPlusPlus/

.. image:: https://github.com/abhiksark/labelImg-plus-plus/actions/workflows/ci.yaml/badge.svg
        :target: https://github.com/abhiksark/labelImg-plus-plus/actions

.. image:: https://img.shields.io/badge/python-3.6+-blue.svg
        :target: https://www.python.org/downloads/

.. image:: https://img.shields.io/badge/license-MIT-green.svg
        :target: https://github.com/abhiksark/labelImg-plus-plus/blob/master/LICENSE

----

**labelImg++** is a powerful graphical image annotation tool for creating bounding box labels, designed for machine learning and computer vision projects. Forked from the original LabelImg with significant enhancements.

    **Version 2.0.0** - First stable release! Install with ``pip install labelImgPlusPlus``

.. image:: resources/demo/labelimg_screenshot.png
     :alt: labelImg++ Screenshot
     :align: center

Features
--------

Core Annotation Features
~~~~~~~~~~~~~~~~~~~~~~~~

- **Multi-format support**: PASCAL VOC (XML), YOLO (TXT), CreateML (JSON)
- **Bounding box annotation** with drag-and-drop interface
- **Auto-save mode** for uninterrupted workflow
- **Predefined class labels** with customizable list
- **Verification system** to mark completed annotations

New in labelImg++ v2.0
~~~~~~~~~~~~~~~~~~~~~~

**Undo/Redo Support**
    Full undo/redo for all annotation actions. Press **Ctrl+Z** to undo and **Ctrl+Y** to redo. Never lose your work again!

**Gallery Mode with Annotation Preview**
    Visual thumbnail gallery showing all images with bounding box overlays directly on thumbnails.

    - Colored borders indicate status: Gray (no labels), Blue (has labels), Green (verified)
    - Bounding boxes visible on thumbnails with corner markers (less clutter for nested boxes)
    - Quick size presets (S/M/L/XL) plus slider for fine control
    - Smart selection: click on nested boxes selects the inner box
    - Press **Ctrl+G** to toggle gallery mode

**Modern UI with Feather Icons**
    Clean, modern interface with beautiful Feather icons and improved visual design.

**Responsive DPI Scaling**
    Icons and UI elements scale properly on high-DPI displays (4K, Retina).

**Expandable Toolbar**
    Click the chevron at the bottom of the toolbar to expand/collapse and show full button labels.

**Consolidated File Menu**
    Open File, Open Dir, and Change Save Dir combined into a single dropdown for cleaner toolbar.

**Brightness Adjustment**
    Adjust image brightness on-the-fly to better see annotations on dark or light images.

Installation
------------

From PyPI (Recommended)
~~~~~~~~~~~~~~~~~~~~~~~

.. code:: shell

    pip3 install labelImgPlusPlus
    labelImgPlusPlus

With a specific image or directory:

.. code:: shell

    labelImgPlusPlus [IMAGE_PATH] [PRE-DEFINED CLASS FILE] [SAVE_DIR]

Build from Source
~~~~~~~~~~~~~~~~~

**Ubuntu/Linux:**

.. code:: shell

    sudo apt-get install pyqt5-dev-tools
    pip3 install -r requirements/requirements-linux-python3.txt
    make qt5py3
    python3 labelImg.py

**macOS:**

.. code:: shell

    pip3 install pyqt5 lxml
    make qt5py3
    python3 labelImg.py

**Windows:**

.. code:: shell

    pip install pyqt5 lxml
    pyrcc5 -o libs/resources.py resources.qrc
    python labelImg.py

Quick Start
-----------

1. **Open images**: Click the file dropdown button or press **Ctrl+U** to load a directory
2. **Create annotations**: Press **W** or click **Create RectBox**, then drag to draw
3. **Label objects**: Select a class from the popup dialog
4. **Save**: Press **Ctrl+S** to save annotations
5. **Navigate**: Use **D** (next) and **A** (previous) to move between images
6. **Review**: Press **Ctrl+G** for gallery mode to review all annotations

Supported Annotation Formats
----------------------------

+---------------+------------+------------------------------------------+
| Format        | Extension  | Description                              |
+===============+============+==========================================+
| PASCAL VOC    | .xml       | ImageNet format, absolute coordinates    |
+---------------+------------+------------------------------------------+
| YOLO          | .txt       | Normalized coordinates (0-1), with       |
|               |            | classes.txt for class names              |
+---------------+------------+------------------------------------------+
| CreateML      | .json      | Apple's ML format for iOS/macOS          |
+---------------+------------+------------------------------------------+

Keyboard Shortcuts
------------------

**File Operations**

+--------------------+--------------------------------------------+
| Ctrl + O           | Open file                                  |
+--------------------+--------------------------------------------+
| Ctrl + U           | Open directory                             |
+--------------------+--------------------------------------------+
| Ctrl + R           | Change save directory                      |
+--------------------+--------------------------------------------+
| Ctrl + S           | Save current annotation                    |
+--------------------+--------------------------------------------+
| Ctrl + Shift + S   | Save as                                    |
+--------------------+--------------------------------------------+

**Navigation**

+--------------------+--------------------------------------------+
| D                  | Next image                                 |
+--------------------+--------------------------------------------+
| A                  | Previous image                             |
+--------------------+--------------------------------------------+
| Ctrl + G           | Toggle Gallery Mode                        |
+--------------------+--------------------------------------------+

**Annotation**

+--------------------+--------------------------------------------+
| W                  | Create bounding box                        |
+--------------------+--------------------------------------------+
| Ctrl + Z           | Undo                                       |
+--------------------+--------------------------------------------+
| Ctrl + Y           | Redo                                       |
+--------------------+--------------------------------------------+
| Ctrl + D           | Duplicate selected box                     |
+--------------------+--------------------------------------------+
| Del                | Delete selected box                        |
+--------------------+--------------------------------------------+
| Space              | Mark image as verified                     |
+--------------------+--------------------------------------------+
| Arrow keys         | Move selected box                          |
+--------------------+--------------------------------------------+

**View**

+--------------------+--------------------------------------------+
| Ctrl + +           | Zoom in                                    |
+--------------------+--------------------------------------------+
| Ctrl + -           | Zoom out                                   |
+--------------------+--------------------------------------------+
| Ctrl + F           | Fit window                                 |
+--------------------+--------------------------------------------+
| Ctrl + Shift + F   | Fit width                                  |
+--------------------+--------------------------------------------+

Configuration
-------------

**Predefined Classes**

Edit ``data/predefined_classes.txt`` to customize the label options:

.. code::

    dog
    cat
    person
    car
    bicycle

**Reset Settings**

If you encounter issues, reset the settings:

.. code:: shell

    rm ~/.labelImgSettings.pkl

Or use **Menu > File > Reset All**

Roadmap
-------

**v2.0.0 (Stable)** - *Current*
    First stable release with bug fixes and UX improvements

    - Silent error handling fixed
    - YOLO format crash on missing classes.txt fixed
    - Format change warning dialog added
    - Save location visibility in title bar
    - Auto-save menu items clarified
    - Gallery status color legend added
    - Progress indicator for large directories
    - Gallery size presets (S/M/L/XL buttons)
    - Corner markers on thumbnails for cleaner nested box display
    - Improved nested bounding box selection (smallest box selected)
    - Gallery freeze fix for large directories

**v2.1.0** - *Planned*
    - Annotation review workflow
    - Dataset splitting tool (train/val/test)
    - Label consistency checker
    - Annotation statistics dashboard
    - Improved label dialog with search/filter
    - Keyboard shortcuts customization

**v2.2.0** - *Future*
    - Dark mode theme
    - Polygon annotation support
    - Recent files menu
    - Snap to grid / alignment guides

**v3.0.0** - *Vision*
    - Plugin architecture
    - COCO format support
    - Ultralytics/YOLOv8 direct export
    - FiftyOne dataset integration

See the `GitHub Issues <https://github.com/abhiksark/labelImg-plus-plus/issues>`_ for detailed feature tracking.

Contributing
------------

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (``git checkout -b feature/amazing-feature``)
3. Commit your changes (``git commit -m 'Add amazing feature'``)
4. Push to the branch (``git push origin feature/amazing-feature``)
5. Open a Pull Request

License
-------

`MIT License <https://github.com/abhiksark/labelImg-plus-plus/blob/master/LICENSE>`_

Based on LabelImg by Tzutalin.

Author
------

Maintained by `Abhik Sarkar <https://abhik.ai>`__

Acknowledgments
---------------

- Original LabelImg by Tzutalin
- `Feather Icons <https://feathericons.com/>`__ for modern iconography
- All contributors and users of labelImg++
