semvec/pypi-packages huggingface dataset:
snapbox 0.1.2
Draw boxes over images.
License: MIT
Keywords: box, image

=======
SnapBox
=======
.. External dependencies

.. _tkinter: https://docs.python.org/3/library/tkinter.html
.. _Pillow: https://python-pillow.org/
.. _pipx: https://pipx.pypa.io/

.. Internal references

.. _SnapBox: https://github.com/barseghyanartur/snapbox/
.. _Read the Docs: http://snapbox.readthedocs.io/
.. _Contributor guidelines: https://snapbox.readthedocs.io/en/latest/contributor_guidelines.html

Put bounding boxes over images.

.. image:: https://img.shields.io/pypi/v/snapbox.svg
   :target: https://pypi.python.org/pypi/snapbox
   :alt: PyPI Version

.. image:: https://img.shields.io/pypi/pyversions/snapbox.svg
    :target: https://pypi.python.org/pypi/snapbox/
    :alt: Supported Python versions

.. image:: https://github.com/barseghyanartur/snapbox/actions/workflows/test.yml/badge.svg?branch=main
   :target: https://github.com/barseghyanartur/snapbox/actions
   :alt: Build Status

.. image:: https://readthedocs.org/projects/snapbox/badge/?version=latest
    :target: http://snapbox.readthedocs.io
    :alt: Documentation Status

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
   :target: https://github.com/barseghyanartur/snapbox/#License
   :alt: MIT

.. image:: https://coveralls.io/repos/github/barseghyanartur/snapbox/badge.svg?branch=main&service=github
    :target: https://coveralls.io/github/barseghyanartur/snapbox?branch=main
    :alt: Coverage

Features
========
- Put bounding boxes over images.
- Export altered images.

Prerequisites
=============
- Python 3.8+
- `tkinter`_
- `Pillow`_

Installation
============
Using `pipx`_
-------------
*Recommended*

.. code-block:: sh

    pipx install snapbox

Using `pip`
-----------
.. code-block:: sh

    pip install snapbox

Documentation
=============
- Documentation is available on `Read the Docs`_.
- For guidelines on contributing check the `Contributor guidelines`_.

Usage
=====
.. code-block:: sh

    snapbox

Tests
=====

Run the tests with unittest:

.. code-block:: sh

    python -m unittest snapbox.py

Or pytest:

.. code-block:: sh

    pytest

License
=======

MIT

Support
=======
For security issues contact me at the e-mail given in the `Author`_ section.

For overall issues, go to `GitHub <https://github.com/barseghyanartur/snapbox/issues>`_.

Author
======

Artur Barseghyan <artur.barseghyan@gmail.com>