move ubx utilities to pyubxutils

semuconsulting · Dec 11, 2024 · be3d94f · be3d94f
1 parent 5b3cc02
commit be3d94f
Show file tree

Hide file tree

Showing 14 changed files with 14 additions and 1,675 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -5,5 +5,5 @@
     "python.defaultInterpreterPath": "python3",
     "modulename": "${workspaceFolderBasename}",
     "distname": "${workspaceFolderBasename}",
-    "moduleversion": "1.1.8"
+    "moduleversion": "1.1.9"
 }
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,5 +1,11 @@
 # pygnssutils Release Notes
 
+### RELEASE 1.1.9
+
+CHANGES:
+
+1. ubx CLI utilities moved to `pyubxutils` - `ubxsave`, `ubxload`, `ubxcompare`, `ubxsetrate`, `ubxsimulator`. For the time being, `pyubxutils` will remain a dependency of `pygnssutils` and will be installed alongside it via pip, and `from pygnssutils import UBXSimulator` will still work as an import statement, but these will be removed altogether in v1.2.0.
+
 ### RELEASE 1.1.8
 
 ENHANCEMENTS:

diff --git a/docs/pygnssutils.rst b/docs/pygnssutils.rst
@@ -116,54 +116,6 @@ pygnssutils.socketwrapper module
    :undoc-members:
    :show-inheritance:
 
-pygnssutils.ubxcompare module
------------------------------
-
-.. automodule:: pygnssutils.ubxcompare
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pygnssutils.ubxload module
---------------------------
-
-.. automodule:: pygnssutils.ubxload
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pygnssutils.ubxsave module
---------------------------
-
-.. automodule:: pygnssutils.ubxsave
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pygnssutils.ubxsetrate module
------------------------------
-
-.. automodule:: pygnssutils.ubxsetrate
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pygnssutils.ubxsimulator module
--------------------------------
-
-.. automodule:: pygnssutils.ubxsimulator
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pygnssutils.ubxsimulator\_cli module
-------------------------------------
-
-.. automodule:: pygnssutils.ubxsimulator_cli
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 Module contents
 ---------------
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -7,7 +7,7 @@ name = "pygnssutils"
 authors = [{ name = "semuadmin", email = "[email protected]" }]
 maintainers = [{ name = "semuadmin", email = "[email protected]" }]
 description = "GNSS Command Line Utilities"
-version = "1.1.8"
+version = "1.1.9"
 license = { file = "LICENSE" }
 readme = "README.md"
 requires-python = ">=3.9"
@@ -39,19 +39,14 @@ dependencies = [
     "pyserial>=3.5",
     "pyspartn>=1.0.5",
     "pyubx2>=1.2.48",
+    "pyubxutils>=1.0.2",
 ]
 
 [project.scripts]
 gnssstreamer = "pygnssutils.gnssstreamer_cli:main"
-gnssdump = "pygnssutils.gnssstreamer_cli:main"           # for backwards compatibility
 gnssserver = "pygnssutils.gnssserver_cli:main"
 gnssntripclient = "pygnssutils.gnssntripclient_cli:main"
 gnssmqttclient = "pygnssutils.gnssmqttclient_cli:main"
-ubxsetrate = "pygnssutils.ubxsetrate:main"
-ubxsave = "pygnssutils.ubxsave:main"
-ubxload = "pygnssutils.ubxload:main"
-ubxsimulator = "pygnssutils.ubxsimulator_cli:main"
-ubxcompare = "pygnssutils.ubxcompare:main"
 
 [project.urls]
 homepage = "https://github.com/semuconsulting/pygnssutils"

diff --git a/src/pygnssutils/__init__.py b/src/pygnssutils/__init__.py
@@ -6,6 +6,8 @@
 :license: BSD 3-Clause
 """
 
+from pyubxutils.ubxsimulator import UBXSimulator
+
 from pygnssutils._version import __version__
 from pygnssutils.exceptions import GNSSStreamError, ParameterError
 from pygnssutils.globals import *
@@ -16,9 +18,5 @@
 from pygnssutils.helpers import *
 from pygnssutils.mqttmessage import *
 from pygnssutils.socketwrapper import SocketWrapper
-from pygnssutils.ubxload import UBXLoader
-from pygnssutils.ubxsave import UBXSaver
-from pygnssutils.ubxsetrate import UBXSetRate
-from pygnssutils.ubxsimulator import UBXSimulator
 
 version = __version__  # pylint: disable=invalid-name
diff --git a/src/pygnssutils/_version.py b/src/pygnssutils/_version.py
@@ -8,4 +8,4 @@
 :license: BSD 3-Clause
 """
 
-__version__ = "1.1.8"
+__version__ = "1.1.9"
diff --git a/src/pygnssutils/gnssserver_cli.py b/src/pygnssutils/gnssserver_cli.py
@@ -15,6 +15,7 @@
 from socket import create_connection, gethostbyname
 from time import sleep
 
+from pyubxutils.ubxsimulator import UBXSimulator
 from serial import Serial
 
 from pygnssutils._version import __version__ as VERSION
@@ -32,7 +33,6 @@
 from pygnssutils.gnssserver import GNSSSocketServer
 from pygnssutils.helpers import set_common_args
 from pygnssutils.socketwrapper import SocketWrapper
-from pygnssutils.ubxsimulator import UBXSimulator
 
 
 def _run_streamer(stream, **kwargs):

diff --git a/src/pygnssutils/gnssstreamer_cli.py b/src/pygnssutils/gnssstreamer_cli.py
@@ -37,6 +37,7 @@
 from types import FunctionType
 
 from pyubx2 import ERR_LOG, SETPOLL, UBXReader
+from pyubxutils.ubxsimulator import UBXSimulator
 from serial import Serial, SerialException
 
 from pygnssutils._version import __version__ as VERSION
@@ -75,7 +76,6 @@
 from pygnssutils.helpers import parse_url, set_common_args
 from pygnssutils.socket_server import runserver
 from pygnssutils.socketwrapper import SocketWrapper
-from pygnssutils.ubxsimulator import UBXSimulator
 
 STATUSINTERVAL = 5
 

diff --git a/src/pygnssutils/ubxcompare.py b/src/pygnssutils/ubxcompare.py