interactive-figure 0.3.3__tar.gz → 0.3.4__tar.gz

{interactive_figure-0.3.3 → interactive_figure-0.3.4}/.gitignore

@@ -1,160 +1,160 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/

{interactive_figure-0.3.3 → interactive_figure-0.3.4}/LICENSE.txt

@@ -1,7 +1,7 @@
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

{interactive_figure-0.3.3 → interactive_figure-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: interactive-figure
-Version: 0.3.3
+Version: 0.3.4
 Summary: Create interactive Matplotlib figures!
 Project-URL: Documentation, https://teuncm.github.io/interactive-figure/autoapi/interactive_figure/interactive_figure/index.html
 Project-URL: Issues, https://github.com/teuncm/interactive-figure/issues
@@ -38,29 +38,15 @@ pip install interactive-figure
 from interactive_figure import interactive_figure
 
 interactive_figure.create()
-# Stall until user input is received.
+# Wait until user input is received.
 interactive_figure.wait_for_interaction()
-key = interactive_figure.get_last_keypress()
+key = interactive_figure.get_last_key_press()
 print(f"Pressed key: {key}")
 interactive_figure.close()
 ```
 
 Demos can be found in the *demo* folder on GitHub.
 
-## Functionality
-
-#### User interaction
-- Capture key presses, button presses and mouse location
-
-#### Figure control
-- Create
-- Toggle fullscreen
-- Clear
-- Wait
-- Wait for interaction (optionally timeout)
-- Draw
-- Close
-
 ## Limitations
 
 - Waiting for user input will not work in Jupyter Notebooks and the interactive interpreter due to the way Matplotlib handles events.
@@ -74,6 +60,7 @@ pipx install hatch
 hatch shell
 
 # Build
+hatch version fix
 hatch build -c
 ./generate_docs.sh
 ```

{interactive_figure-0.3.3 → interactive_figure-0.3.4}/README.md

@@ -1,65 +1,52 @@
-# Interactive Figure
-
-This package serves for students to learn the basics of Python, Matplotlib and setting up reaction time experiments (visual search task, Stroop task, etc.). For a more accurate timing environment one should refer to e.g. [PsychoPy](https://www.psychopy.org/).
-
-This is currently used at the University of Amsterdam (UvA) in the course *Introduction to Python Programming for Neuroscientists*.
-
-Package created using [Hatch](https://hatch.pypa.io).
-
-## Installation
-
-```shell
-pip install interactive-figure
-```
-
-## Usage
-
-```python
-from interactive_figure import interactive_figure
-
-interactive_figure.create()
-# Stall until user input is received.
-interactive_figure.wait_for_interaction()
-key = interactive_figure.get_last_keypress()
-print(f"Pressed key: {key}")
-interactive_figure.close()
-```
-
-Demos can be found in the *demo* folder on GitHub.
-
-## Functionality
-
-#### User interaction
-- Capture key presses, button presses and mouse location
-
-#### Figure control
-- Create
-- Toggle fullscreen
-- Clear
-- Wait
-- Wait for interaction (optionally timeout)
-- Draw
-- Close
-
-## Limitations
-
-- Waiting for user input will not work in Jupyter Notebooks and the interactive interpreter due to the way Matplotlib handles events.
-- Automated testing is hard since tests should cover multiple backends (macosx, QtAgg, Tkgg) on multiple platforms (Windows, macOS, Linux). Tips are very welcome!
-
-## Development
-
-```bash
-# Setup
-pipx install hatch
-hatch shell
-
-# Build
-hatch build -c
-./generate_docs.sh
-```
-
-## Links
-
-- [GitHub](https://github.com/teuncm/interactive-figure)
-- [PyPI](https://pypi.org/project/interactive-figure/)
+# Interactive Figure
+
+This package serves for students to learn the basics of Python, Matplotlib and setting up reaction time experiments (visual search task, Stroop task, etc.). For a more accurate timing environment one should refer to e.g. [PsychoPy](https://www.psychopy.org/).
+
+This is currently used at the University of Amsterdam (UvA) in the course *Introduction to Python Programming for Neuroscientists*.
+
+Package created using [Hatch](https://hatch.pypa.io).
+
+## Installation
+
+```shell
+pip install interactive-figure
+```
+
+## Usage
+
+```python
+from interactive_figure import interactive_figure
+
+interactive_figure.create()
+# Wait until user input is received.
+interactive_figure.wait_for_interaction()
+key = interactive_figure.get_last_key_press()
+print(f"Pressed key: {key}")
+interactive_figure.close()
+```
+
+Demos can be found in the *demo* folder on GitHub.
+
+## Limitations
+
+- Waiting for user input will not work in Jupyter Notebooks and the interactive interpreter due to the way Matplotlib handles events.
+- Automated testing is hard since tests should cover multiple backends (macosx, QtAgg, Tkgg) on multiple platforms (Windows, macOS, Linux). Tips are very welcome!
+
+## Development
+
+```bash
+# Setup
+pipx install hatch
+hatch shell
+
+# Build
+hatch version fix
+hatch build -c
+./generate_docs.sh
+```
+
+## Links
+
+- [GitHub](https://github.com/teuncm/interactive-figure)
+- [PyPI](https://pypi.org/project/interactive-figure/)
 - [Documentation](https://teuncm.github.io/interactive-figure/autoapi/interactive_figure/interactive_figure/index.html)

{interactive_figure-0.3.3 → interactive_figure-0.3.4}/demo/press.py

@@ -1,54 +1,54 @@
-# This demo shows all the button press registering possibilities.
-
-from interactive_figure import interactive_figure
-import matplotlib.pyplot as plt
-
-
-def main():
-    interactive_figure.create()
-    run_demo()
-    interactive_figure.close()
-
-
-def run_demo():
-    plt.title("Feedback will appear here.")
-    interactive_figure.draw()
-
-    while True:
-        interactive_figure.wait_for_interaction()
-
-        key = interactive_figure.get_last_key_press()
-        mouse = interactive_figure.get_last_mouse_press()
-        x, y = interactive_figure.get_last_mouse_pos()
-
-        interactive_figure.clear()
-
-        # Exit if q is pressed outside rectangle.
-        if x is None or y is None:
-            if key == "q":
-                print("Closing...")
-                return
-        # Plot keys if pressed inside rectangle.
-        else:
-            x = round(x, 3)
-            y = round(y, 3)
-
-            if not key is None:
-                plt.text(x, y, key, ha="center", va="center", fontsize="large")
-            elif mouse == 1:
-                plt.plot(x, y, "r.", ms=13)
-            elif mouse == 2:
-                plt.plot(x, y, "g.", ms=13)
-            elif mouse == 3:
-                plt.plot(x, y, "b.", ms=13)
-            else:
-                # Any other mouse button.
-                plt.plot(x, y, "k.", ms=13)
-
-        plt.title(f"key: {key}, x: {x}, y: {y}")
-
-        interactive_figure.draw()
-
-
-if __name__ == "__main__":
-    main()
+# This demo shows all the button press registering possibilities.
+
+from interactive_figure import interactive_figure
+import matplotlib.pyplot as plt
+
+
+def main():
+    interactive_figure.create()
+    run_demo()
+    interactive_figure.close()
+
+
+def run_demo():
+    plt.title("Feedback will appear here.")
+    interactive_figure.draw()
+
+    while True:
+        interactive_figure.wait_for_interaction()
+
+        key = interactive_figure.get_last_key_press()
+        mouse = interactive_figure.get_last_mouse_press()
+        x, y = interactive_figure.get_last_mouse_pos()
+
+        interactive_figure.clear()
+
+        # Exit if q is pressed outside rectangle.
+        if x is None or y is None:
+            if key == "q":
+                print("Closing...")
+                return
+        # Plot keys if pressed inside rectangle.
+        else:
+            x = round(x, 3)
+            y = round(y, 3)
+
+            if not key is None:
+                plt.text(x, y, key, ha="center", va="center", fontsize="large")
+            elif mouse == 1:
+                plt.plot(x, y, "r.", ms=13)
+            elif mouse == 2:
+                plt.plot(x, y, "g.", ms=13)
+            elif mouse == 3:
+                plt.plot(x, y, "b.", ms=13)
+            else:
+                # Any other mouse button.
+                plt.plot(x, y, "k.", ms=13)
+
+        plt.title(f"key: {key}, x: {x}, y: {y}")
+
+        interactive_figure.draw()
+
+
+if __name__ == "__main__":
+    main()