An open-source python toolkit to deal with gaze tracking and analysis in Augmented Reality (AR) environnement.

## Architecture

The ArGaze toolkit is divided in submodules dedicated to various purposes:

* ArUcoMarkers: ArUco markers generator, traking, camera calibration, ...
* RegionOfInterest: Region Of Interest (ROI) scene management for 2D and 3D environment.
* TobiiGlassesPro2: A gaze tracking device interface.
* utils: Collection of command-line high level features scripts based on ArGaze toolkit.

## Installation

Consider that all inline commands below needs to be executed into ArGaze root folder.

- Build package: 

```
python -m build
```

- Then, install package (replace VERSION by what has been built into dist folder):

```
pip install ./dist/argaze-VERSION.whl
```

As Argaze library developper, you should prefer to install the package in developer mode to test live code changes:

```
pip install -e .
```

## Documentation

To generate html documentation using [pdoc](https://pdoc.dev/), 

- Install 'pdoc' package:

```
pip install pdoc
```

- Then, build documentation into doc folder:

```
pdoc -o ./doc ./src/argaze/ 
```

As Argaze library developper, you should prefer to create a local html server to watch live documentation changes:

```
pdoc ./src/argaze/
```