python: Merge test/pytest/testlib as main python package

... and prepare for publishing to pypi. The old "raw wrapper" is now called osdp_sys and testlib replaces it the main osdp module. Signed-off-by: Siddharth Chandrasekaran <[email protected]>
goToMain · Nov 22, 2023 · b9b04c7 · b9b04c7
1 parent af47df7
commit b9b04c7
Show file tree

Hide file tree

Showing 33 changed files with 318 additions and 243 deletions.
diff --git a/.gitignore b/.gitignore
@@ -70,6 +70,7 @@ config.make
 __pycache__/
 .cache/
 *.pyc
+.venv/
 
 ## Rust
 /Cargo.lock

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -41,7 +41,6 @@ include(GitSubmodules)
 add_subdirectory(utils)
 add_subdirectory(src)
 if (NOT CONFIG_OSDP_STATIC_PD AND NOT CONFIG_OSDP_LIB_ONLY)
-	add_subdirectory(tests/pytest)
 	add_subdirectory(tests/unit-tests)
 	add_subdirectory(samples/c)
 	add_subdirectory(samples/cpp)

diff --git a/python/.gitignore b/python/.gitignore
@@ -0,0 +1,3 @@
+*.egg-info/
+build/
+dist/
diff --git a/python/CMakeLists.txt b/python/CMakeLists.txt
diff --git a/tests/pytest/testlib/__init__.py → python/osdp/__init__.py b/tests/pytest/testlib/__init__.py → python/osdp/__init__.py
diff --git a/python/osdp/constants.py b/python/osdp/constants.py
@@ -0,0 +1,71 @@
+#
+#  Copyright (c) 2021-2023 Siddharth Chandrasekaran <[email protected]>
+#
+#  SPDX-License-Identifier: Apache-2.0
+#
+
+import osdp_sys
+
+class LibFlag:
+    EnforceSecure = osdp_sys.FLAG_ENFORCE_SECURE
+    InstallMode = osdp_sys.FLAG_INSTALL_MODE
+    IgnoreUnsolicited = osdp_sys.FLAG_IGN_UNSOLICITED
+
+class LogLevel:
+    Emergency = osdp_sys.LOG_EMERG
+    Alert = osdp_sys.LOG_ALERT
+    Critical = osdp_sys.LOG_CRIT
+    Error = osdp_sys.LOG_ERROR
+    Warning = osdp_sys.LOG_WARNING
+    Notice = osdp_sys.LOG_NOTICE
+    Info = osdp_sys.LOG_INFO
+    Debug = osdp_sys.LOG_DEBUG
+
+class Command:
+    Output = osdp_sys.CMD_OUTPUT
+    Buzzer = osdp_sys.CMD_BUZZER
+    LED = osdp_sys.CMD_LED
+    Comset = osdp_sys.CMD_COMSET
+    Text = osdp_sys.CMD_TEXT
+    Manufacturer = osdp_sys.CMD_MFG
+    Keyset = osdp_sys.CMD_KEYSET
+    FileTransfer = osdp_sys.CMD_FILE_TX
+
+class CommandLEDColor:
+    Black = osdp_sys.LED_COLOR_NONE
+    Red = osdp_sys.LED_COLOR_RED
+    Green = osdp_sys.LED_COLOR_GREEN
+    Amber = osdp_sys.LED_COLOR_AMBER
+    Blue = osdp_sys.LED_COLOR_BLUE
+
+class CommandFileTxFlags:
+    Cancel = osdp_sys.CMD_FILE_TX_FLAG_CANCEL
+
+class Event:
+    CardRead = osdp_sys.EVENT_CARDREAD
+    KeyPress = osdp_sys.EVENT_KEYPRESS
+    ManufacturerReply = osdp_sys.EVENT_MFGREP
+    InputOutput = osdp_sys.EVENT_IO
+    Status = osdp_sys.EVENT_STATUS
+
+class CardFormat:
+    Unspecified = osdp_sys.CARD_FMT_RAW_UNSPECIFIED
+    Wiegand = osdp_sys.CARD_FMT_RAW_WIEGAND
+    ASCII = osdp_sys.CARD_FMT_ASCII
+
+class Capability:
+    Unused = osdp_sys.CAP_UNUSED
+    ContactStatusMonitoring = osdp_sys.CAP_CONTACT_STATUS_MONITORING
+    OutputControl = osdp_sys.CAP_OUTPUT_CONTROL
+    CardDataFormat = osdp_sys.CAP_CARD_DATA_FORMAT
+    LEDControl = osdp_sys.CAP_READER_LED_CONTROL
+    AudibleControl = osdp_sys.CAP_READER_AUDIBLE_OUTPUT
+    TextOutput = osdp_sys.CAP_READER_TEXT_OUTPUT
+    TimeKeeping = osdp_sys.CAP_TIME_KEEPING
+    CheckCharacter = osdp_sys.CAP_CHECK_CHARACTER_SUPPORT
+    CommunicationSecurity = osdp_sys.CAP_COMMUNICATION_SECURITY
+    ReceiveBufferSize = osdp_sys.CAP_RECEIVE_BUFFERSIZE
+    CombinedMessageSize = osdp_sys.CAP_LARGEST_COMBINED_MESSAGE_SIZE
+    SmartCard = osdp_sys.CAP_SMART_CARD_SUPPORT
+    Readers = osdp_sys.CAP_READERS
+    Biometrics = osdp_sys.CAP_BIOMETRICS
diff --git a/tests/pytest/testlib/control_panel.py → python/osdp/control_panel.py b/tests/pytest/testlib/control_panel.py → python/osdp/control_panel.py
@@ -6,7 +6,7 @@
 import sys
 import os
 import tempfile
-import osdp
+import osdp_sys
 import time
 import queue
 import threading
@@ -25,9 +25,9 @@ def __init__(self, pd_info_list, log_level: LogLevel=LogLevel.Info,
             info_list.append(pd_info.get())
         self.event_queue = [ queue.Queue() for i in self.pd_addr ]
         if master_key:
-            self.ctx = osdp.ControlPanel(info_list, master_key=master_key)
+            self.ctx = osdp_sys.ControlPanel(info_list, master_key=master_key)
         else:
-            self.ctx = osdp.ControlPanel(info_list)
+            self.ctx = osdp_sys.ControlPanel(info_list)
         self.ctx.set_event_callback(self.event_handler)
         self.ctx.set_loglevel(log_level)
         self.event = None

diff --git a/tests/pytest/testlib/helpers.py → python/osdp/helpers.py b/tests/pytest/testlib/helpers.py → python/osdp/helpers.py
diff --git a/tests/pytest/testlib/key_store.py → python/osdp/key_store.py b/tests/pytest/testlib/key_store.py → python/osdp/key_store.py
diff --git a/tests/pytest/testlib/peripheral_device.py → python/osdp/peripheral_device.py b/tests/pytest/testlib/peripheral_device.py → python/osdp/peripheral_device.py
@@ -4,7 +4,7 @@
 #  SPDX-License-Identifier: Apache-2.0
 #
 
-import osdp
+import osdp_sys
 import time
 import queue
 import threading
@@ -17,7 +17,7 @@ def __init__(self, pd_info: PDInfo, pd_cap: PDCapabilities,
                  log_level: LogLevel=LogLevel.Info):
         self.command_queue = queue.Queue()
         self.address = pd_info.address
-        self.ctx = osdp.PeripheralDevice(pd_info.get(), capabilities=pd_cap.get())
+        self.ctx = osdp_sys.PeripheralDevice(pd_info.get(), capabilities=pd_cap.get())
         self.ctx.set_loglevel(log_level)
         self.ctx.set_command_callback(self.command_handler)
         self.event = None

diff --git a/python/pyosdp_base.c → python/osdp_sys/base.c b/python/pyosdp_base.c → python/osdp_sys/base.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "pyosdp.h"
+#include "module.h"
 
 #define TAG "pyosdp_base"
 

diff --git a/python/pyosdp_cp.c → python/osdp_sys/cp.c b/python/pyosdp_cp.c → python/osdp_sys/cp.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "pyosdp.h"
+#include "module.h"
 
 #define TAG "pyosdp_cp"
 

diff --git a/python/pyosdp_data.c → python/osdp_sys/data.c b/python/pyosdp_data.c → python/osdp_sys/data.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "pyosdp.h"
+#include "module.h"
 
 /* ------------------------------- */
 /*            COMMANDS             */

diff --git a/python/pyosdp.c → python/osdp_sys/module.c b/python/pyosdp.c → python/osdp_sys/module.c
@@ -4,12 +4,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "pyosdp.h"
+#include "module.h"
 #include <stdio.h>
 
-static PyModuleDef osdp_module = {
+static PyModuleDef osdp_sys_module = {
 	PyModuleDef_HEAD_INIT,
-	.m_name = "osdp",
+	.m_name = "osdp_sys",
 	.m_doc = "Open Supervised Device Protocol",
 	.m_size = -1,
 };
@@ -90,11 +90,11 @@ void pyosdp_add_module_constants(PyObject *module)
 #undef ADD_CONST
 }
 
-PyMODINIT_FUNC PyInit_osdp(void)
+PyMODINIT_FUNC PyInit_osdp_sys(void)
 {
 	PyObject *module;
 
-	module = PyModule_Create(&osdp_module);
+	module = PyModule_Create(&osdp_sys_module);
 	if (module == NULL)
 		return NULL;
 

diff --git a/python/pyosdp.h → python/osdp_sys/module.h b/python/pyosdp.h → python/osdp_sys/module.h
diff --git a/python/pyosdp_pd.c → python/osdp_sys/pd.c b/python/pyosdp_pd.c → python/osdp_sys/pd.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "pyosdp.h"
+#include "module.h"
 
 #define TAG "pyosdp_pd"
 

diff --git a/python/pyosdp_utils.c → python/osdp_sys/utils.c b/python/pyosdp_utils.c → python/osdp_sys/utils.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "pyosdp.h"
+#include "module.h"
 
 int pyosdp_dict_add_bool(PyObject *dict, const char *key, bool val)
 {
@@ -226,4 +226,4 @@ int pyosdp_dict_get_object(PyObject *dict, const char *key, PyObject **obj)
 		return -1;
 
 	return 0;
-}
+}
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -1,3 +1,3 @@
 [build-system]
-requires = ["setuptools >= 57.2.0", "wheel"]
+requires = ["setuptools >= 57.2.0"]
 build-backend = "setuptools.build_meta"