Skip to content

Commit

Permalink
Add a note about venv to install instructions
Browse files Browse the repository at this point in the history
As with any Python project that requires modules to be installed via pip, use of a virtual environment is a good idea for this project. I hadn't mentioned that in an effort to keep things simple and because I figured people who cared about such things already knew about venv and how to use it.

As mentioned in issue #99, though, some OS distributions have started marking the system Python packages as owned by the system and will throw an error if you try to install additional modules there using pip. venv instructions vary a little by system, though, so rather than dictate that people have to use it in a certain way and complicate the install instructions to boot, there is now a note about it being recommended and sometimes required along with a link to usage instructions.
  • Loading branch information
sparky8512 committed Nov 24, 2024
1 parent 3589733 commit 686362c
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ This repository has a handful of tools for interacting with the [gRPC](https://g

For more information on what Starlink is, see [starlink.com](https://www.starlink.com/) and/or the [r/Starlink subreddit](https://www.reddit.com/r/Starlink/).

## Prerequisites
## Prerequisites / Installation

Most of the scripts here are [Python](https://www.python.org/) scripts. To use them, you will either need Python installed on your system or you can use the Docker image. If you use the Docker image, you can skip the rest of the prerequisites other than making sure the dish IP is reachable and Docker itself. For Linux systems, the python package from your distribution should be fine, as long as it is Python 3, version 3.7 or later.

Expand All @@ -13,7 +13,9 @@ Running the scripts within a [Docker](https://www.docker.com/) container require

### Required Python modules (for non-Docker usage)

The easiest way to get the Python modules used by the scripts is to do the following, which will install latest versions of a superset of the required modules:
The scripts require a number of Python modules to be present in your local Python environment. It is recommended to [create and use a virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) (venv) for this purpose, but usually not required. However, some OS distribution's Python installations may require the use of venv when running at `root`/`Administrator` user. If you don't want to deal with that, either install as a different user, or add the `--user` option after the word `install` in the following command, but be aware that will only make it available to that user.

The easiest way to get the required modules is to run the following command, which will install latest versions of a superset of the required modules:
```shell script
pip install --upgrade -r requirements.txt
```
Expand Down

0 comments on commit 686362c

Please sign in to comment.