Metadata-Version: 2.4
Name: screen-region-selector
Version: 0.1.0
Summary: Interactive screen region selection returning a NumPy array.
Author-email: Marc Steger <marc.steger06@gmail.com>
License: GNU General Public License v3.0
Project-URL: Homepage, https://github.com/MarcyVibin/screen-region-selector
Project-URL: Issues, https://github.com/MarcyVibin/screen-region-selector/issues
Keywords: screen,screenshot,capture,selection,tkinter
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Multimedia :: Graphics :: Capture :: Screen Capture
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: mss
Requires-Dist: screeninfo
Dynamic: license-file

<a id="readme-top"></a>

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License][license-shield]][license-url]

<h3 align="center">Screen Region Selector</h3>

<p align="center">
    A lightweight Python library for interactively selecting a region of your screen and retrieving it as a NumPy array.
    <br />
    <br />
    <a href="https://github.com/MarcyVibin/screen-selector/issues">Report Bug</a>
    &middot;
    <a href="https://github.com/MarcyVibin/screen-selector/issues">Request Feature</a>
</p>

<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#requirements">Requirements</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
  </ol>
</details>

---

## About The Project

**Screen Region Selector** is a lightweight Python library that lets users interactively select a region of their screen and instantly retrieve the selected area as a NumPy array.

The library is designed for applications such as:

- Computer vision
- OCR
- Machine learning datasets
- Automation tools
- Screenshot utilities

The returned image is a standard RGB NumPy array, making it easy to integrate with libraries such as OpenCV, Pillow, or custom image-processing pipelines.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Built With

* [![Python][Python.org]][Python-url]
* [![NumPy][NumPy-badge]][NumPy-url]
* [![MSS][MSS-badge]][MSS-url]
* [![ScreenInfo][ScreenInfo-badge]][ScreenInfo-url]
* Tkinter (built into Python)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

## Getting Started

### Requirements

- Windows
- Python 3.10+

### Installation

Install from PyPI:

```sh
pip install screen-region-selector
```

Or install the latest development version:

```sh
pip install git+https://github.com/MarcyVibin/screen-selector.git
```

---

## Usage

```python
from screen_selector import select_region

image = select_region()

print(image.shape)
```

The returned object is a NumPy `ndarray` in RGB format.

---

## License

Distributed under the GNU General Public License v3.0 (GPL-3.0). See `LICENSE` for more information.

---

## Contact

Marc Steger - marc.steger06@gmail.com

Project Link: https://github.com/MarcyVibin/screen-selector

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- Badge Links -->

[Python.org]: https://img.shields.io/badge/Python-3.10+-3776AB?style=for-the-badge&logo=python&logoColor=white
[Python-url]: https://www.python.org/

[NumPy-badge]: https://img.shields.io/badge/NumPy-013243?style=for-the-badge&logo=numpy&logoColor=white
[NumPy-url]: https://numpy.org/

[MSS-badge]: https://img.shields.io/badge/MSS-Screenshot-blue?style=for-the-badge
[MSS-url]: https://github.com/BoboTiG/python-mss

[ScreenInfo-badge]: https://img.shields.io/badge/ScreenInfo-Monitor%20Detection-green?style=for-the-badge
[ScreenInfo-url]: https://github.com/rr-/screeninfo

[contributors-shield]: https://img.shields.io/github/contributors/MarcyVibin/screen-selector.svg?style=for-the-badge
[contributors-url]: https://github.com/MarcyVibin/screen-selector/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/MarcyVibin/screen-selector.svg?style=for-the-badge
[forks-url]: https://github.com/MarcyVibin/screen-selector/network/members

[stars-shield]: https://img.shields.io/github/stars/MarcyVibin/screen-selector.svg?style=for-the-badge
[stars-url]: https://github.com/MarcyVibin/screen-selector/stargazers

[issues-shield]: https://img.shields.io/github/issues/MarcyVibin/screen-selector.svg?style=for-the-badge
[issues-url]: https://github.com/MarcyVibin/screen-selector/issues

[license-shield]: https://img.shields.io/github/license/MarcyVibin/screen-selector.svg?style=for-the-badge
[license-url]: https://github.com/MarcyVibin/screen-selector/blob/main/LICENSE
