Server refactor, add tests and coverage

Author: petermuller

.gitignore

@@ -1,4 +1,5 @@
 *.py[cod]
+.venv
 
 # C extensions
 *.so
@@ -34,3 +35,6 @@ nosetests.xml
 .mr.developer.cfg
 .project
 .pydevproject
+
+# IDE files
+.idea

README.md

@@ -4,15 +4,14 @@ Server for GPIO Controller phone applications
 
 ## Directions
 
-1. Copy the Python files (.py) to your Raspberry Pi
-2. Ensure your Raspberry Pi distro is up to date (# yum/apt-get upgrade)
-3. Install python3, python3-flask, and flask-cors
-4. As root, run the command "python PiServer.py"
-5. Use `curl` commands to test the server until the phone applications are updated to use the new implementation. Example: `curl -X GET http://localhost:5000/get-pin-value/7` or `curl -X POST http://localhost:5000/set-pin-value/7/1`
+1. Clone this repository into your Raspberry Pi
+2. Create a virtualenv environment and install the dependencies
+3. As root (because of Pin permissions), start the server
+4. Have fun!
 
-## New to Version 2
-
-* Server now implements a Flask server instead of a raw socket connection
-    * This breaks the related phone applications until they are updated with the new interface
-* Networking and Pi functionality are separated for better modularity
-* Removing PWM functionality to favor logical HIGH and LOW outputs
+## Version 3
+This is the third rewrite of this server, but this should be the easiest to interact with.
+Main features for this version are:
+* FastAPI usage instead of Flask
+  * This allows for OpenAPI clients to interact with the server
+* Cleaner code

pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pi-phone-server"
+version = "3.0.0"
+dependencies = [
+    "fastapi",
+    "uvicorn"
+]
+requires-python = ">=3.10"
+authors = [
+    {name = "Peter Muller"}
+]
+description = "REST server for interacting with Raspberry Pi GPIO pins"
+readme = "README.md"
+license = {file = "LICENSE"}
+keywords = ["raspberrypi", "raspberry", "pi", "server"]
+
+[project.optional-dependencies]
+test = [
+    "coverage",
+    "pytest"
+]
+raspi = [
+    "RPi.GPIO"
+]
+
+[project.urls]
+Repository = "https://github.com/petermuller/pi-phone-server"
+
+[tool.pytest.ini_options]
+addopts = "--junitxml=build/test_report.xml"
+
+[tool.coverage.run]
+branch = true
+command_line = "-m pytest"
+source_pkgs = [
+    "pi_phone_server"
+]
+omit = [
+    "test/*"
+]
+
+[tool.coverage.report]
+ignore_errors = false
+fail_under = 50
+format = "markdown"
+
+[tool.coverage.xml]
+output = "build/coverage.xml"
+
+[tool.coverage.html]
+directory = "build/coverage_html_report"

requirements.txt

@@ -0,0 +1,2 @@
+fastapi
+uvicorn

setup.py

@@ -0,0 +1,6 @@
+#!/user/bin/env python
+
+import setuptools
+
+if __name__ == "__main__":
+    setuptools.setup()

src/pi_phone_server/__init__.py

@@ -0,0 +1,6 @@
+class InvalidOperationError(RuntimeError):
+    pass
+
+
+class InvalidPinError(RuntimeError):
+    pass