semuconsulting / pygnssutils

Python GNSS CLI utility library for reading, parsing and broadcasting NMEA, UBX, RTCM3, NTRIP and SPARTN protocols
BSD 3-Clause "New" or "Revised" License
84 stars 25 forks source link

What is the "python 3 scripts (bin) folder"? #33

Closed tlalexander closed 1 year ago

tlalexander commented 1 year ago

The readme says: "pygnssutils is compatible with Python >=3.8. It is recommended that the Python 3 scripts (bin) folder is in your PATH."

After installation I am unable to run the commands (I get "command not found"), so it seems this bin folder is not in my PATH.

I have tried to google for "python3 bin folder" and I am not finding any clear answer as to what that folder is or what its path should be on my debian system. I am about to go figure this out, but I wanted to suggest adding some clearer text here for future users. I also assume there is some way to run these commands without that folder being in the PATH, so some instructions on that as a fallback might also be helpful.

Thanks!

tlalexander commented 1 year ago

Ah for running it without knowing the path, I can just do:

python3 -m pygnssutils.gnssserver

So maybe that tip can be added to the readme.

I don't really know what's up with my system configuration that the script did not work the normal way, but I am going to move on to debugging my GPS issue. Thanks for this package and I hope my feedback is useful.

semuadmin commented 1 year ago

Hi @tlalexander

Sorry you're having difficulties. These libraries do assume some prior knowledge of running Python scripts and modules.

You can normally choose the location of your Python bin/scripts folder during the installation procedure. Typically, the Python bin/scripts path will default to somewhere like this:

On Linux, try running the command which python3.

The procedure for adding this location to your PATH also depends on the operating system and the terminal 'shell' you're using (e.g. bash or zsh).

Running Python modules with the -m option is different to running scripts. The following tutorial might help:

https://realpython.com/run-python-scripts/

I'll close this as an issue, but if you need further guidance by all means post a follow-up query to the pygnssutils Discussion Channels.

tlalexander commented 1 year ago

Sure, thanks I have made a discussion: https://github.com/semuconsulting/pygnssutils/discussions/34