Pymovements

💥 Breaking Changes

- correct pixel origin string to upper left instead of lower left (710)
- enforce list of strings for GazeDataFrame.trial\_columns attribute (669)
- add time column if missing during gaze initialization (654)
- rename GazeDataFrame.copy() to clone() (657)

✨ Enhancements

- introduce measure\_samples(), MeasureLibrary and null\_ratio (673)
- add clip transformation (700)
- timestamp unit specification (643)
- parse eyelink metadata (702)
- add text stimulus class (676)
- add deg2pix transformation (699)
- parse eyelink metadata (674)
- add EyeTracker class (617)
- trialize gaze.detect() (655)
- add EventDataFrame.add\_trial\_column() (671)
- add trial\_columns to EventDataFrame (670)
- enforce list of strings for GazeDataFrame.trial\_columns attribute (669)
- add time column if missing during gaze initialization (654)
- add trial\_columns to from\_numpy() and from\_pandas() (651)
- rename GazeDataFrame.copy() to clone() (657)

🐞 Bug Fixes

- forward experiment from dataset definition to from\_asc (711)
- correct pixel origin string to upper left instead of lower left (710)
- update checksum of PoTeC resource file (691)
- don't fail in event fill if event onsets/offsets not within timesteps (656)

🛠️ Maintenance

- use gaze.io for loading dataset files (698)
- disable too-many-instance-attributes in pylint (709)
- use smaller subset in 10 minutes tutorial (707)
- add 'Integration and IO' rubric to api reference docs (630)
- update contributing.md for new tox command (684)
- update licenses to 2024 (659)
- workaround ci failure by pinning nbconvert\<7.14 (652)
- include teaser in readme (639)
- add support for python 3.12 (660)
- update github action versions (685)
- improve tox integration command (693)
- remove macOS documentation test builder from CI (697)
- add typing\_extensions to be able to install pymovements from source (682)
- improve exception messages in GazeDataFrame.transform() (661)
- update pyopenssl requirement from \<24.0.0,>=16.0.0 to >=16.0.0,\<25.0.0 (668)
- update pyarrow requirement from \<15,>=11.0.0 to >=11.0.0,\<16 (665)
- remove default stages entry from pre-commit config (658)
- update pydocstyle ignores (650)
- update polars requirement from \<0.20.2,>=0.20.1 to >=0.20.1,\<0.20.3 (646)
- update polars requirement from \<0.19.20,>=0.19.19 to >=0.20.1,\<0.20.2 (644)
- fix expected values in parsing (645)
- update polars requirement from \<0.19.16,>=0.19.14 to >=0.19.19,\<0.19.20 (641)

👷👷‍♀️👷‍♂️ Contributors
Shoutout to all our contributors for making this release possible!
OmerShubi, SiQube, dependabot, dkrako, jakobchwastek, josephine-funken, prassepaul and theDebbister

✨ Enhancements

- add PoTeC dataset (636)

🛠️ Maintenance

- add pydoclint to pre-commit (638)
- add missing column argument docs and note on csv column dtypes (594)
- ignore bot commits in changelog (633)
- update polars requirement from \<0.19.14,>=0.19.12 to >=0.19.14,\<0.19.16 (628)
- raise minor version on breaking changes only (624)
- don't fail pytest on incomplete coverage (625)
- avoid invocation error in integration test (627)
- add construction worker emojis to release draft (632)

👷👷‍♀️👷‍♂️ Contributors
Shoutout to all our contributors for making this release possible!
SiQube, dkrako, jakobchwastek and prassepaul

✨ Enhancements

- Add gaze.from\_asc() (590)
- add new dataset GazeGraph (619)
- gaze\_dataframe.unnest() supports multi-col unnest (592)
- optionally remove single-child top-level directory from extracted archives (579)

🐞 Bug Fixes

- avoid SchemaFieldNotFoundError when loading preprocessed data (614)

🛠️ Maintenance

- update polars requirement from \<0.19.13 to \<0.19.14 (622)
- test for warning when distance column and distance\_cm specified (615)
- use minor version for polars upper version bound (621)
- update pyarrow requirement from \<14 to \<15 (620)
- migrate deprecated polars funtions (612)
- add git alias hint for creating new branches (608)
- migrate to polars v0.19.12 (618)



👷👷‍♀️👷‍♂️ Contributors
Shoutout to josephine-funken for making their first contributions in 579 and 612

dkrako, jakobchwastek, josephine-funken, prassepaul, SiQube, and theDebbister



**Full Changelog**: https://github.com/aeye-lab/pymovements/compare/v0.17.1...v0.17.2

✨ Enhancements


🐞 Bug Fixes
- correct hash in sb-sat definition (606)
- specify column dtypes in dataset definitions (593)
- specify schema for ToyDatasetEyeLink (601)


🛠️ Maintenance
- treat warnings as errors (602)
- add publish github workflow (604)
- don't setup python twice in github workflow (605)
- test for minimum version of dependencies (599)
- add github workflow for autolabeler (603)
- add integration tests for public datasets (591)
- create release-drafter.yml (598)


Shoutout to all our contributors for making this release possible!
dkrako prassepaul


**Full Changelog**: https://github.com/aeye-lab/pymovements/compare/v0.17.0...v0.17.1

✨ Enhancements
* Add time_column argument to gaze.integration functions https://github.com/aeye-lab/pymovements/pull/497
* Add kwargs for explicit data passing in gaze.from_numpy() https://github.com/aeye-lab/pymovements/pull/513
* Raise helpful missing column error message for transforms https://github.com/aeye-lab/pymovements/pull/542
* Add EventDataFrame.copy() https://github.com/aeye-lab/pymovements/pull/552
* Add events to GazeDataFrame init https://github.com/aeye-lab/pymovements/pull/553
* Add events to gaze.integration functions https://github.com/aeye-lab/pymovements/pull/554
* Add GazeDataFrame.detect() https://github.com/aeye-lab/pymovements/pull/511
* Add gaze.from_csv() https://github.com/aeye-lab/pymovements/pull/557
* Add GazeDataFrame.apply() https://github.com/aeye-lab/pymovements/pull/558
* Add public dataset GazeOnFaces https://github.com/aeye-lab/pymovements/pull/567
* Add gaze.from_ipc() https://github.com/aeye-lab/pymovements/pull/568
* Add dataset sbsat https://github.com/aeye-lab/pymovements/pull/575
* Add HBN dataset https://github.com/aeye-lab/pymovements/pull/576
* Add gaze.transforms.smooth() https://github.com/aeye-lab/pymovements/pull/555
* Add Dataset.apply() https://github.com/aeye-lab/pymovements/pull/490
* Load .txt files as .csv files https://github.com/aeye-lab/pymovements/pull/584
* Variable eye to screen distance https://github.com/aeye-lab/pymovements/pull/583

🐞 Bug fixes
* Infer correct number of components in gaze init https://github.com/aeye-lab/pymovements/pull/521

🛠️ Other improvements
* Update GazeDataFrame Docstring to Include Missing trial_columns Argument https://github.com/aeye-lab/pymovements/pull/494
* Add latex formulas to event property docstrings https://github.com/aeye-lab/pymovements/pull/491
* Upload documentation artifacts for PRs https://github.com/aeye-lab/pymovements/pull/498
* Add pydocstyle to pre-commit hooks https://github.com/aeye-lab/pymovements/pull/505
* Decrease pytest verbosity https://github.com/aeye-lab/pymovements/pull/515
* Update CONTRIBUTING.md https://github.com/aeye-lab/pymovements/pull/544
* Migrate to polars v0.19 https://github.com/aeye-lab/pymovements/pull/545
* Integrate dependabot to check for dependency updates https://github.com/aeye-lab/pymovements/pull/546
* update pyarrow requirement from <12,>=11.0.0 to >=11.0.0,<14 https://github.com/aeye-lab/pymovements/pull/547
* don't include scope in dependabot commits https://github.com/aeye-lab/pymovements/pull/549
* add pip installation of pylint to CONTRIBUTING.md https://github.com/aeye-lab/pymovements/pull/556
* remove unused pre-commit env from tox.ini https://github.com/aeye-lab/pymovements/pull/564
* pre-commit autoupdate https://github.com/aeye-lab/pymovements/pull/566
* Migrate typing to matplotlib v3.8.0 https://github.com/aeye-lab/pymovements/pull/563
* Test resulting filestructure for utils.archives.extract() https://github.com/aeye-lab/pymovements/pull/570
* pre-commit autoupdate https://github.com/aeye-lab/pymovements/pull/578
* update CONTRIBUTING.md about possible pandoc installation https://github.com/aeye-lab/pymovements/pull/574
* drop support for python 3.8 https://github.com/aeye-lab/pymovements/pull/572
* update matplotlib requirement from <3.8,>=3.0.0 to >=3.0.0,<3.9 https://github.com/aeye-lab/pymovements/pull/577
* remove mypy ignore imports for matplotlib https://github.com/aeye-lab/pymovements/pull/565
* Add test example files for each public dataset https://github.com/aeye-lab/pymovements/pull/581
* pre-commit autoupdate https://github.com/aeye-lab/pymovements/pull/582
* Reuse dataset definitions in from_csv tests https://github.com/aeye-lab/pymovements/pull/586
* Add functional tests for preprocessing gaze files https://github.com/aeye-lab/pymovements/pull/585
* Remove mypy and flake8 from tox and github actions https://github.com/aeye-lab/pymovements/pull/587
* Refactor GitHub workflows https://github.com/aeye-lab/pymovements/pull/588
* Refactor tests into unit and functional https://github.com/aeye-lab/pymovements/pull/589

Contributors
Shoutout to all our contributors for making this release possible!
dkrako jakobchwastek prassepaul SiQube

New Contributors
* dependabot made their first contribution in https://github.com/aeye-lab/pymovements/pull/547

**Full Changelog**: https://github.com/aeye-lab/pymovements/compare/v0.16.1...v0.17.0

✨ Enhancements
* Allow for empty lists in gaze component initializers in https://github.com/aeye-lab/pymovements/pull/484
* Add suffixes argument to GazeDataFrame.unnest() in https://github.com/aeye-lab/pymovements/pull/479
* Add GazeDataFrame.copy() in https://github.com/aeye-lab/pymovements/pull/485

🐞 Bug fixes
* Get rid of unnest side effect during GazeDataFrame.save() in https://github.com/aeye-lab/pymovements/pull/486
* Fix broken load method in https://github.com/aeye-lab/pymovements/pull/489

🛠️ Other improvements
* Remove unused event detection args in https://github.com/aeye-lab/pymovements/pull/462

Contributors
Shoutout to all our contributors for making this release possible!
dkrako jakobchwastek SiQube theDebbister

**Full Changelog**: https://github.com/aeye-lab/pymovements/compare/v0.16.0...v0.16.1