Software tools to manage and analyze gaze data from eye-trackers
Project description
The Python package gazelib provides software tools to manage and analyze gaze data from eye-trackers.
Gazelib is developed at Infant Cognition Laboratory at University of Tampere.
Install
With pip:
$ pip install gazelib
Docs
Examples and API docs are available at http://gazelib.readthedocs.org/.
For developers
Tips for the developers of the package.
Use Git
To develop, clone the repository from GitHub:
$ git clone https://github.com/infant-cognition-tampere/gazelib
Make changes to files, add them to commit, and do commit:
(edit README.rst) $ git add README.rst $ git commit -m "Improved documentation"
List files that are not added or not committed:
$ git status
Push local commits to GitHub:
$ git push
Ignore some files by editing .gitignore:
$ nano .gitignore
Virtualenv
Manage python versions and requirements by using virtualenv:
$ cd gazelib $ virtualenv -p python3.5 venv $ source venv/bin/activate ... $ deactivate
Testing
Follow instructions to install pyenv and then either run quick tests:
$ python3.5 setup.py test
or run comprehensive tests for multiple Python versions listed in tox.ini:
$ pyenv local 2.7.10 3.1.5 3.2.6 3.3.6 3.4.3 3.5.0 $ eval "$(pyenv init -)" $ pyenv rehash $ tox
Install new pyenv environments for example by:
$ pyenv install 3.5.0
Validate README.rst at http://rst.ninjs.org/
Tox + Travis CI + Coveralls:
Publishing to PyPI
Follow python packaging instructions:
Create an unpacked sdist: $ python setup.py sdist
Create a universal wheel: $ python setup.py bdist_wheel --universal
Go to PyPI and register the project by filling the package form by uploading gazelib.egg-info/PKG_INFO file.
Upload the package with twine:
Sign the dist: $ gpg --detach-sign -a dist/gazelib-1.2.3.tar.gz and $ gpg --detach-sign -a dist/gazelib-1.2.3-py2.py3-none-any.whl
Upload: twine upload dist/gazelib-1.2.3* (will ask your PyPI password)
Package published!
Updating the package takes same steps except the 3rd.
Version release
Change version string in gazelib/version.py and setup.py to '1.2.3'
Run tox tests. See 4.3. Testing.
Git commit: $ git commit --all -m "v1.2.3 release"
Create tag: $ git tag -a 1.2.3 -m "v1.2.3 stable"
Push commits and tags: $ git push && git push --tags
Publish to PyPI. See 4.4. Publishing to PyPI.
See also a successful Git branching model.
Compile documentation
Run $ make -C docs html
This will execute $ sphinx-apidoc -o docs gazelib automatically.
ReadTheDocs.org builds the documentation automatically after push to GitHub.
Manage ReadTheDocs build at readthedocs.org/projects/gazelib.
Versioning
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gazelib-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7c17b4f1c4045f73c68a05453bd7153cd618c9a6f97756a7faf17bdad68f70d |
|
MD5 | 53c37e6d1fb3c5ee0b0ee190e1894520 |
|
BLAKE2b-256 | f8a50e3077c6d8693773076d0472534ee4299451ddb756636ad530ec6683e8da |