Skip to main content

Eyekit is a Python package for analyzing reading behavior using eyetracking data. Eyekit aims to be entirely independent of any particular eyetracker hardware, experiment software, or data formats. It has an object-oriented style that defines three core objects – the TextBlock, InterestArea, and FixationSequence – that you bring into contact with a bit of coding.

Is Eyekit the Right Tool for Me?

  • You want to analyze which parts of a text someone is looking at and for how long.

  • You need convenient tools for extracting areas of interest from texts, such as specific words, phrases, or letter combinations.

  • You want to calculate common reading measures, such as gaze duration or initial landing position.

  • You need support for arbitrary fonts, multiline passages, right-to-left text, or non-alphabetical scripts.

  • You want the flexibility to define custom reading measures and to build your own reproducible processing pipeline.

  • You would like tools for dealing with noise and calibration issues, and for discarding fixations according to your own criteria.

  • You want to share your data in an open format and produce publication-ready vector graphics.

Installation

Eyekit may be installed using pip:

$ pip install eyekit

Eyekit is compatible with Python 3.8+. Its main dependency is the graphics library Cairo, which you might also need to install if it's not already on your system. Many Linux distributions have Cairo built in. On a Mac, it can be installed using Homebrew: brew install cairo. On Windows, it can be installed using Anaconda: conda install -c anaconda cairo.

Full documentation and a usage guide is available here

Contributing

This project is in the stable/maintenance phase and is not under active development. I am only aiming to fix bugs and keep it compatible with current versions of Python so that it remains useful to the community. With that in mind, contributions are very welcome, but please read the CONTRIBUTING file before submitting a pull request.

Metadata

Release files for eyekit 0.7.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eyekit 0.7.1
File Size Uploaded
eyekit-0.7.1.tar.gz 967.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for eyekit 0.7.1
File Interpreter ABI Platform
eyekit-0.7.1-py3-none-any.whl Python 3 none any Details

Total release size: 1.0 MB

Release files / eyekit-0.7.1.tar.gz

Download URL eyekit-0.7.1.tar.gz
Size 967.1 kB
Tags Source
SHA-256 checksum
How to use checksums
56eab623e8c9dd46e14ffbbf0d5cae58563881ecfb69f919a7785bde61d971b1
BLAKE2b-256 checksum
How to use checksums
2dd80825dcaf05986f7244bf6423fefd52c36ecc109d88fcb6a9462fc38d68c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.13.0

Release files / eyekit-0.7.1-py3-none-any.whl

Download URL eyekit-0.7.1-py3-none-any.whl
Size 69.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1bb59ee660fe5fbfee54246d03f235585b477914cf2cf69da69e897d121e59b1
BLAKE2b-256 checksum
How to use checksums
5a902c0edd4e39227dca902e4e0c6a1edc6863182fe5625fa664922d2ab44d45
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.13.0

Release history Release notifications | RSS feed

This release

0.7.1 This release

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.14

2 release files

0.3.13

2 release files

0.3.11

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.14

2 release files

0.2.13

2 release files

0.2.12

2 release files

0.2.11

2 release files

0.2.10

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page