Introduce package structure

reemo3dp · Feb 29, 2024 · c736349 · c736349
1 parent 06376f1
commit c736349
Show file tree

Hide file tree

Showing 26 changed files with 793 additions and 424 deletions.
diff --git a/install-led_effect.sh b/install-led_effect.sh
@@ -24,7 +24,7 @@ while getopts "k:c:uh" arg; do
 done
 
 # Find SRCDIR from the pathname of this script
-SRCDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )"/src/ && pwd )"
+SRCDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )"/ && pwd )"
 
 # Verify Klipper has been installed
 check_klipper()
@@ -56,7 +56,7 @@ check_folders()
 link_extension()
 {
     echo -n "Linking extension to Klipper... "
-    ln -sf "${SRCDIR}/led_effect.py" "${KLIPPER_PATH}/klippy/extras/led_effect.py"
+    ln -sf "${SRCDIR}/packages/led_effect" "${KLIPPER_PATH}/klippy/extras/led_effect"
     echo "[OK]"
 }
 
@@ -110,13 +110,13 @@ stop_klipper()
 
 uninstall()
 {
-    if [ -f "${KLIPPER_PATH}/klippy/extras/led_effect.py" ]; then
+    if [ -d "${KLIPPER_PATH}/klippy/extras/led_effect" ]; then
         echo -n "Uninstalling... "
-        rm -f "${KLIPPER_PATH}/klippy/extras/led_effect.py"
+        rm -f "${KLIPPER_PATH}/klippy/extras/led_effect"
         echo "[OK]"
         echo "You can now remove the [update_manager led_effect] section in your moonraker.conf and delete this directory. Also remove all led_effect configurations from your Klipper configuration."
     else
-        echo "led_effect.py not found in \"${KLIPPER_PATH}/klippy/extras/\". Is it installed?"
+        echo "led_effect not found in \"${KLIPPER_PATH}/klippy/extras/\". Is it installed?"
         echo "[FAILED]"
     fi
 }

diff --git a/packages/klippermock/poetry.lock b/packages/klippermock/poetry.lock
diff --git a/packages/klippermock/pyproject.toml b/packages/klippermock/pyproject.toml
@@ -0,0 +1,14 @@
+[tool.poetry]
+name = "klippermock"
+version = "0.1.0"
+authors = ["Julian Schill <[email protected]>"]
+description = ""
+
+[tool.poetry.dependencies]
+python = "<3.12,>=3.8"
+led_effect = {path = "../led_effect", develop = true}
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
diff --git a/simulator/simulator/__init__.py → packages/klippermock/src/__init__.py b/simulator/simulator/__init__.py → packages/klippermock/src/__init__.py
diff --git a/simulator/simulator/klippermock.py → packages/klippermock/src/klippermock.py b/simulator/simulator/klippermock.py → packages/klippermock/src/klippermock.py
@@ -7,7 +7,7 @@
 print(root)
 sys.path.append(str(root))
 from pathlib import Path
-from src.led_effect import ledEffect, ledFrameHandler
+from led_effect import ledEffect, ledFrameHandler
 
 class mockPrinter:
     NOW = 0

diff --git a/packages/led_effect/poetry.lock b/packages/led_effect/poetry.lock
diff --git a/packages/led_effect/pyproject.toml b/packages/led_effect/pyproject.toml
@@ -0,0 +1,12 @@
+[tool.poetry]
+name = "led-effect"
+version = "0.1.0"
+authors = ["Julian Schill <[email protected]>"]
+description = ""
+
+[tool.poetry.dependencies]
+python = "<3.12,>=3.8"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
diff --git a/simulator/tests/__init__.py → packages/led_effect/src/__init__.py b/simulator/tests/__init__.py → packages/led_effect/src/__init__.py
diff --git a/src/led_effect.py → packages/led_effect/src/led_effect.py b/src/led_effect.py → packages/led_effect/src/led_effect.py
diff --git a/packages/led_effect_tests/poetry.lock b/packages/led_effect_tests/poetry.lock
diff --git a/packages/led_effect_tests/pyproject.toml b/packages/led_effect_tests/pyproject.toml
@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "led-effect-tests"
+version = "0.1.0"
+authors = ["Julian Schill <[email protected]>"]
+description = ""
+package-mode = false
+
+[tool.poetry.dependencies]
+python = "<3.12,>=3.8"
+klippermock = {path = "../klippermock", develop = true}
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.0.1"
+pytest-golden = "^0.2.2"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
diff --git a/src/golden/breathing.yml → ...led_effect_tests/src/golden/breathing.yml b/src/golden/breathing.yml → ...led_effect_tests/src/golden/breathing.yml
diff --git a/src/golden/comet.yml → ...ges/led_effect_tests/src/golden/comet.yml b/src/golden/comet.yml → ...ges/led_effect_tests/src/golden/comet.yml
diff --git a/src/golden/gradient.yml → .../led_effect_tests/src/golden/gradient.yml b/src/golden/gradient.yml → .../led_effect_tests/src/golden/gradient.yml
diff --git a/src/golden/sb_critical_error.yml → ...ct_tests/src/golden/sb_critical_error.yml b/src/golden/sb_critical_error.yml → ...ct_tests/src/golden/sb_critical_error.yml
diff --git a/src/golden/static.yml → ...es/led_effect_tests/src/golden/static.yml b/src/golden/static.yml → ...es/led_effect_tests/src/golden/static.yml
diff --git a/src/golden/strobe.yml → ...es/led_effect_tests/src/golden/strobe.yml b/src/golden/strobe.yml → ...es/led_effect_tests/src/golden/strobe.yml
diff --git a/src/led_effect_golden_test.py → ...ffect_tests/src/led_effect_golden_test.py b/src/led_effect_golden_test.py → ...ffect_tests/src/led_effect_golden_test.py
@@ -1,12 +1,5 @@
 import pytest
-
-import sys
-from pathlib import Path  # if you haven't already done so
-file = Path(__file__).resolve()
-parent, root = file.parent, file.parents[1]
-sys.path.append(str(root))
-
-from simulator.simulator.klippermock import *
+from klippermock import *
 
 NUM_FRAMES = 100
 

diff --git a/simulator/app.py → packages/simulator/app.py b/simulator/app.py → packages/simulator/app.py