Metadata-Version: 2.1
Name: scrollthescroll
Version: 0.0.8
Summary: Automatic scrolling with real-time eye-tracking
Home-page: https://github.com/Theo-eBrown/scrollthescroll
Author: Theo Brown
Author-email: theo.elliott.brown@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/Theo-eBrown/scrollthescroll/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Scroll The Scroll
Automatic scrolling based on real time eye tracking with python
### Scroll The Scroll Project
*Scrollthescroll* is a python package for automatic scrolling based on real time eye tracking using a webcam. By tracking the movement of the users pupils using a webcam it can estimate when the user has read a line and can scroll accordingly. *Scrollthescroll* allows a user to maintain focus on a fixed quadrant of the screen, making reading on devices easier.

### About
*Scrollthescroll* is currently in its prototype stages and works only with local PDF files.
*Scrollthescroll* is currently only in working condition for Windows OS, however new changes are coming soon.
### Usage
Install the PyPI package:
```bash
pip install scrollthescroll
```
or clone the repository (no installation required, source files are sufficient):
```bash
git clone https://github.com/Theo-eBrown/scrollthescroll
```
or [download and extract the zip](https://github.com/Theo-eBrown/scrollthescroll/archive/refs/heads/master.zip "download and extract the zip").
### Example
Running the scrollthescroll prototype:
```python
from scrollthescroll import Prototype

p = Prototype()

file_path = "c:\\users\\user\\apdf.pdf"
page_number = 10

p.run(file_path, page_number)
```

