Initial commit

.gitignore

@@ -0,0 +1,9 @@
+# Compiled python modules.
+*.pyc
+
+# Setuptools distribution folder.
+/dist/
+
+# Python egg metadata, regenerated from source files by setuptools.
+/*.egg-info
+/*.egg

MANIFEST.in

@@ -0,0 +1 @@
+include piket/sounds/*.wav

README.md

@@ -0,0 +1,13 @@
+# piket
+
+## Attribution
+This project contains the following files from external sources:
+
+- ["Plop" sound effect][plopsound], by
+	[`michaelkoehler`][michaelkoehler-freesound],
+	licensed under [CC BY 3.0].
+	Located in `piket/sounds/plop.wav`.
+
+[plopsound]: https://freesound.org/people/michaelkoehler/sounds/207191/
+[michaelkoehler-freesound]: https://freesound.org/people/michaelkoehler/
+[CC BY 3.0]: https://creativecommons.org/licenses/by/3.0/

piket/__init__.py

@@ -0,0 +1,3 @@
+"""
+Piket, a touch-screen interface for counting consumptions.
+"""

piket/gui.py

@@ -0,0 +1,23 @@
+"""
+Provides the graphical front-end for Piket.
+"""
+import sys
+
+from PySide2.QtWidgets import QApplication, QPushButton
+
+from piket.sound import PLOP_WAVE
+
+
+def plop() -> None:
+    """ Asynchronously play the plop sound. """
+    PLOP_WAVE.play()
+
+
+if __name__ == "__main__":
+    app = QApplication(sys.argv)
+
+    button = QPushButton("Plop!")
+    button.clicked.connect(plop)
+
+    button.show()
+    app.exec_()

piket/sound.py

@@ -0,0 +1,14 @@
+"""
+Provides functions related to playing sounds.
+"""
+
+import os
+
+import simpleaudio as sa
+
+
+SOUNDS_DIR = os.path.join(os.path.dirname(__file__), "sounds")
+""" Contains the absolute path to the sounds directory. """
+
+PLOP_WAVE = sa.WaveObject.from_wave_file(os.path.join(SOUNDS_DIR, "plop.wav"))
+""" SimpleAudio WaveObject containing the plop sound. """

setup.py

@@ -0,0 +1,35 @@
+from setuptools import setup
+
+setup(
+        name='piket',
+        version='0.0.1',
+
+        classifiers=[
+            'Development Status :: 2 - Pre-Alpha',
+            'License :: OSI Approved :: MIT License',
+            'Programming Language :: Python :: 3'
+            'Programming Language :: Python :: 3 :: Only',
+        ],
+
+        url='https://git.maartenberg.nl/maarten/piket',
+        author='Maarten van den Berg',
+        author_email='maartenberg1+pypi@gmail.com',
+
+        license='MIT',
+        packages=['piket'],
+
+        install_requires=[
+            'PySide2',
+            'simpleaudio',
+        ],
+
+        extras_require={
+            'dev': [
+                'black',
+                'pylint',
+            ],
+        },
+
+        include_package_data=True,
+        zip_safe=False
+)