Skip to content

Commit 8c486c1

Browse files
committed
update docs
1 parent f1bf4dd commit 8c486c1

7 files changed

Lines changed: 29 additions & 18 deletions

File tree

CITATION.bib

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ @Misc{PyGPSClient
22
author = {{SEMU Consulting}},
33
howpublished = {GitHub repository},
44
note = {Viewed last: xxxx:xx:xx},
5-
title = {Python Graphical GPS Client Application supporting NMEA, UBX, RTCM3, NTRIP & SPARTN Protocols},
5+
title = {Python Graphical GPS Client Application supporting NMEA, UBX, SBF, UNI, QGC, RTCM3, NTRIP & SPARTN Protocols},
66
year = {2022},
77
url = {https://github.com/semuconsulting/pygpsclient},
88
}

INSTALLATION.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ The exact location of the site_packages and binary directories will depend on th
6161

6262
In the following, `python3` & `pip` refer to the Python 3 executables. You may need to substitute `python` for `python3`, depending on your particular environment (*on Windows it's generally `python`*).
6363

64+
- Graphical User Interface (window system / manager)
6465
- Python >= 3.10⁴
6566
- Tk (tkinter) >= 8.6⁵ (*tkinter is a commonly used library for developing Graphical User Interfaces (GUI) in Python*)
6667
- Screen resolution >= 640 x 480 (VGA); Ideally 1920 x 1080, though at lower screen resolutions (<= 1024 width), top level dialogs will be resizable and scrollable.
@@ -224,25 +225,25 @@ pipx will typically create a virtual environment in the user's home folder e.g.
224225
The following scripts require sudo/admin privileges and will prompt for the sudo password.
225226
226227
### Debian Linux
227-
An example [installation shell script](https://github.com/semuconsulting/PyGPSClient/blob/master/examples/pygpsclient_debian_install.sh) is available for use on most vanilla 64-bit Debian-based desktop environments (e.g. Wayland) with Python>=3.10, including Raspberry Pi OS Trixie and Ubuntu LTS. The script...
228+
An [installation shell script](https://github.com/semuconsulting/PyGPSClient/blob/master/examples/pygpsclient_debian_install.sh) is available for use on most vanilla 64-bit Debian-based desktop environments, including Raspberry Pi OS Trixie and Ubuntu LTS. The script...
228229
- Installs all necessary Python system libraries.
229230
- Installs PyGPSClient into a virtual environment in the user's home directory and adds this environment to the user's PATH.
230231
- Adds user to the relevant /dev/tty* group.
231232
- Creates a desktop application launcher which can be accessed from the Applications..Other menu.
232233
233234
```shell
234-
wget https://raw.githubusercontent.com/semuconsulting/PyGPSClient/refs/heads/master/examples/pygpsclient_debian_install.sh
235-
# or use curl -O ... if you prefer
235+
curl -O https://raw.githubusercontent.com/semuconsulting/PyGPSClient/refs/heads/master/examples/pygpsclient_debian_install.sh
236+
# or use wget ... if you prefer
236237
chmod +x pygpsclient_debian_install.sh
237238
./pygpsclient_debian_install.sh
238239
```
239240
240241
### Arch Linux
241-
An similar example [installation shell script](https://github.com/semuconsulting/PyGPSClient/blob/master/examples/pygpsclient_arch_install.sh) is available for use on most vanilla 64-bit Arch-based desktop environments (e.g. xfce) with Python>=3.10:
242+
A similar [installation shell script](https://github.com/semuconsulting/PyGPSClient/blob/master/examples/pygpsclient_arch_install.sh) is available for use on most vanilla 64-bit Arch-based desktop environments (e.g. Xfce / LightDM):
242243
243244
```shell
244-
wget https://raw.githubusercontent.com/semuconsulting/PyGPSClient/refs/heads/master/examples/pygpsclient_arch_install.sh
245-
# or use curl -O ... if you prefer
245+
curl -O https://raw.githubusercontent.com/semuconsulting/PyGPSClient/refs/heads/master/examples/pygpsclient_arch_install.sh
246+
# or use wget ... if you prefer
246247
chmod +x pygpsclient_arch_install.sh
247248
./pygpsclient_arch_install.sh
248249
```
@@ -251,6 +252,8 @@ chmod +x pygpsclient_arch_install.sh
251252
A similar [installation shell script](https://github.com/semuconsulting/PyGPSClient/blob/master/examples/pygpsclient_macos_install.sh) is available for MacOS 13 or later running a ZSH shell (*Homebrew or MacPorts are **NOT** required*). This will also install the latest official version of Python 3 with tkinter 8.6. Download the script to your Mac and - from the download folder - type:
252253
253254
```shell
255+
curl -O https://raw.githubusercontent.com/semuconsulting/PyGPSClient/refs/heads/master/examples/pygpsclient_macos_install.sh
256+
chmod +x pygpsclient_macos_install.sh
254257
./pygpsclient_macos_install.sh
255258
```
256259

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License ("BSD License 2.0", "Revised BSD License", "New BSD License", or "Modified BSD License")
22

3-
Copyright 2020, semuadmin (Steve Smith)
3+
Copyright 2020-2026, semuadmin (Steve Smith)
44

55
Redistribution and use in source and binary forms, with or without
66
modification, are permitted provided that the following conditions are met:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ For further details, refer to the `pygnssutils` homepage at [https://github.com/
482482

483483
[BSD 3-Clause License](https://github.com/semuconsulting/PyGPSClient/blob/master/LICENSE)
484484

485-
Copyright &copy; 2020, semuadmin (Steve Smith)
485+
Copyright &copy; 2020-2026, semuadmin (Steve Smith)
486486

487487
Application icons from [iconmonstr](https://iconmonstr.com/license/) &copy;.
488488

examples/pygpsclient_arch_install.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ echo "PyGPSClient will be installed at $HOME/pygpsclient/bin"
2525
echo "Installing dependencies..."
2626
sudo pacman -S tk libspatialite
2727

28-
echo "Setting user permissions..."
28+
echo "Setting user permissions for /dev/tty* devices..."
2929
sudo usermod -aG uucp $USER
3030

3131
echo "Creating virtual environment..."
@@ -72,3 +72,4 @@ sed -i '$a# Path to PyGPSClient executable\nexport PATH="${HOME}/pygpsclient/bin
7272
source $PROF # this will throw an error if running as bash script in zsh shell
7373

7474
echo "Installation complete"
75+
echo "You may need to restart before accessing /dev/tty*"

examples/pygpsclient_debian_install.sh

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,25 @@ echo "Installed Python version is $PYVER"
2121

2222
echo "PyGPSClient will be installed at $HOME/pygpsclient/bin"
2323

24-
echo "Installing dependencies..."\
25-
# uncomment any missing dependencies - not normally necessary with RPi OS Trixie
26-
# sudo apt install python3-pip python3-tk python3-pil python3-pil.imagetk \
27-
# libjpeg-dev zlib1g-dev tk-dev python3-rasterio
28-
29-
echo "Setting user permissions..."
24+
# Raspberry Pi OS Trixie desktop comes with all the necessary Python dependencies included
25+
# Ubuntu LTS and a few other Debian desktop distros are missing Python pip, venv, tkinter
26+
# and PIL libraries
27+
RELEASE="$(lsb_release -d)"
28+
echo "Installing dependencies for $RELEASE..."
29+
if [[ $RELEASE == *"Ubuntu"* ]]; then
30+
sudo apt install python3-pip python3-venv python3-tk python3-pil python3-pil.imagetk
31+
sudo apt install libjpeg-dev zlib1g-dev tk-dev python3-rasterio || true
32+
fi
33+
34+
echo "Setting user permissions for /dev/tty* devices..."
3035
sudo usermod -a -G dialout $USER
3136

3237
echo "Creating virtual environment..."
3338
cd $HOME
3439
python3 -m venv pygpsclient
3540
source pygpsclient/bin/activate
36-
python3 -m pip install --upgrade pip pygpsclient rasterio
41+
python3 -m pip install --upgrade pip pygpsclient
42+
python3 -m pip install --upgrade rasterio || true
3743
deactivate
3844

3945
echo "Adding desktop launch icon..."
@@ -73,3 +79,4 @@ sed -i '$a# Path to PyGPSClient executable\nexport PATH="$HOME/pygpsclient/bin:$
7379
source $PROF # this will throw an error if running as bash script in zsh shell
7480

7581
echo "Installation complete"
82+
echo "You may need to restart before accessing /dev/tty*"

examples/pygpsclient_macos_install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
set -e
1818

1919
echo "PyGPSClient will be installed at $HOME/pygpsclient/bin"
20-
VER=3.14.2
20+
VER=3.14.3
2121
echo "Installing Python $VER from python.org ..."
2222
curl https://www.python.org/ftp/python/$VER/python-$VER-macos11.pkg --output python-$VER-macos11.pkg
2323
sudo installer -pkg python-$VER-macos11.pkg -target /

0 commit comments

Comments
 (0)