update and test Makefile, revert easyhid-ng to easyhid, fix udev instructions, rebuild docs

Author: peter

.github/FUNDING.yml

@@ -12,9 +12,6 @@ build-clean:
 	hatch clean
 	hatch build
 
-install: build
-	python3 -m pip install --no-deps --force dist/*.whl
-
 # Publishing (using Hatch)
 publish: build
 	hatch publish
@@ -46,8 +43,7 @@ clean:
 
 # Development
 install-dev:
-	hatch env create
-	python3 -m pip install --editable ".[dev]"
+	hatch run pip install --editable ".[dev]"
 
 # Code Quality
 lint:
@@ -60,14 +56,14 @@ format-check:
 	hatch run ruff format --check .
 
 # Testing
-test:
+test: # FIXME!
 	hatch run test:pytest
 
-test-cov:
+test-cov: # FIXME!
 	hatch run test:pytest --cov-report=html
 
 run-demo:
-	python3 ./examples/01_basic.py
+	hatch run python ./examples/01_basic.py
 
 # Pre-commit
 pre-commit-install:
@@ -77,21 +73,24 @@ pre-commit-run:
 	pre-commit run --all-files
 
 
+# Documentation, using mkdocs and mkdoxy
+install-doxygen:
+	@command -v doxygen >/dev/null || (echo "Please install doxygen (apt/dnf/brew)" && exit 1)
 
 fixRelativeLinkDocs:
 	sed  's/\.\/docs/\./g'  README.md > docs/README.md
 	sed  's/\.\/docs/\./g'  CONTRIBUTING.md > docs/CONTRIBUTING.md
 	sed  's/\.\/docs/\./g'  troubleshooting.md > docs/troubleshooting.md
 
 # Docs
-docs-build: fixRelativeLinkDocs
+docs-build: install-doxygen fixRelativeLinkDocs
 	@echo "Building docs..."
-	mkdocs build
+	hatch run dev:mkdocs build
 
-docs-serve: fixRelativeLinkDocs
+docs-serve: install-doxygen fixRelativeLinkDocs
 	@echo "Serving docs..."
-	mkdocs serve
+	hatch run dev:mkdocs serve
 
-docs-deploy: fixRelativeLinkDocs
+docs-deploy: install-doxygen fixRelativeLinkDocs
 	@echo "Deploying docs..."
-	mkdocs gh-deploy --force
+	hatch run dev:mkdocs gh-deploy

Makefile

@@ -203,7 +203,7 @@ See the [examples/](https://github.com/JakubAndrysek/PySpaceMouse/tree/master/ex
 ### Linux permissions
 
 ```bash
-sudo echo 'KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0664", GROUP="plugdev"' > /etc/udev/rules.d/99-hidraw-permissions.rules
+echo 'KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0664", GROUP="plugdev"' | sudo tee /etc/udev/rules.d/99-hidraw-permissions.rules
 sudo usermod -aG plugdev $USER
 newgrp plugdev
 ```
@@ -231,6 +231,8 @@ pipx install hatch==1.15.1 pre-commit
 
 If you're not familiar with pipx, it lets you install python tools into isolated environments in `~/.local`.
 
+For building the documentation locally, you will also need `doxygen` installed and on the path.
+
 ## Used In
 
 - [TeleMoMa](https://github.com/UT-Austin-RobIn/telemoma) - A Modular and Versatile Teleoperation System for Mobile Manipulation

README.md

@@ -203,7 +203,7 @@ See the [examples/](https://github.com/JakubAndrysek/PySpaceMouse/tree/master/ex
 ### Linux permissions
 
 ```bash
-sudo echo 'KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0664", GROUP="plugdev"' > /etc/udev/rules.d/99-hidraw-permissions.rules
+echo 'KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0664", GROUP="plugdev"' | sudo tee /etc/udev/rules.d/99-hidraw-permissions.rules
 sudo usermod -aG plugdev $USER
 newgrp plugdev
 ```
@@ -218,8 +218,20 @@ export DYLD_LIBRARY_PATH=/opt/homebrew/Cellar/hidapi/<VERSION>/lib:$DYLD_LIBRARY
 
 See [troubleshooting.md](./troubleshooting.md) for help with common issues.
 
-## Used In
+## Developing / Contributing
+
+This project includes a `Makefile` with commands for creating a virtual environment (using hatch), and publishing to pypi.
+
+You will need `hatch` and `pre-commit` for this.
+You can get these by using
+
+```
+pipx install hatch==1.15.1 pre-commit
+```
 
+If you're not familiar with pipx, it lets you install python tools into isolated environments in `~/.local`.
+
+## Used In
 
 - [TeleMoMa](https://github.com/UT-Austin-RobIn/telemoma) - A Modular and Versatile Teleoperation System for Mobile Manipulation
 - [SERL](https://github.com/rail-berkeley/serl) - SERL: A Software Suite for Sample-Efficient Robotic Reinforcement Learning

docs/README.md

@@ -35,7 +35,7 @@ See [Custom Device Configuration](https://spacemouse.kubaandrysek.cz/mouseApi#cu
 
 ### ModuleNotFoundError: No module named 'easyhid'
 
-- Install `easyhid` by `pip install easyhid-ng`.
+- Install `easyhid` by `pip install easyhid`.
 
 ### AttributeError: function/symbol 'hid_enumerate' not found in library '<None>': python3: undefined symbol: hid_enumerate
 

docs/troubleshooting.md

@@ -7,7 +7,10 @@ name = "pyspacemouse"
 dynamic = ["version"]
 description = "Multiplatform Python interface to the 3DConnexion Space Mouse - forked from pyspacenavigator"
 readme = "README.md"
-authors = [{ name = "Jakub Andrýsek", email = "email@kubaandrysek.cz" }]
+authors = [
+    { name = "Jakub Andrýsek", email = "email@kubaandrysek.cz" },
+    { name = "Peter Mitrano", email = "mitranopeter@gmail.com" }
+]
 license = "MIT"
 keywords = [
     "pyspacemouse",
@@ -36,7 +39,7 @@ classifiers = [
     "Operating System :: OS Independent",
     "Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Human Interface Device (HID)",
 ]
-dependencies = ["easyhid-ng", "tomli; python_version < '3.11'"]
+dependencies = ["easyhid", "tomli; python_version < '3.11'"]
 
 [project.urls]
 Documentation = "https://spacemouse.kubaandrysek.cz"
@@ -46,7 +49,6 @@ Source = "https://github.com/JakubAndrysek/pyspacemouse"
 [project.optional-dependencies]
 dev = [
     "build",
-    "twine",
     "ruff>=0.12.0",
     "pytest>=7.0",
     "pytest-cov>=4.0",

pyproject.toml

@@ -35,7 +35,7 @@ See [Custom Device Configuration](https://spacemouse.kubaandrysek.cz/mouseApi#cu
 
 ### ModuleNotFoundError: No module named 'easyhid'
 
-- Install `easyhid` by `pip install easyhid-ng`.
+- Install `easyhid` by `pip install easyhid`.
 
 ### AttributeError: function/symbol 'hid_enumerate' not found in library '<None>': python3: undefined symbol: hid_enumerate