Skip to content

Clarify python virtual environment in README #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mumrah wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify python virtual environment in README #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ pip3 install virtualenv

## Install the software (RPi)

Create an installation directory under opt and install a Python environment into it
Create an installation directory under `/opt` and set it up as a [Python virtual environment](https://github.com/tarpn/tarpn-node-controller#python-virtual-environment).

_These instructions assume an installation directory of /opt/tarpn. However, the software can be installed at any location_
_These instructions assume an installation directory of /opt/tarpn. However, the software can be installed at any user-writeable location_

```shell
sudo mkdir /opt/tarpn-core
Expand Down Expand Up @@ -90,6 +90,14 @@ sudo systemctl enable tarpn-core
sudo systemctl start tarpn-core
```

## Python Virtual Environment

These instructions will install the software into what is known as a Python virtual environment (sometimes called a "venv"). This is a directory that contains an isolated set of libraries for Python to use. This way, a project can use different versions of libraries than the ones that are installed in the system-wide Python environment (as you would get from doing apt-get install python-serial, for example).

Additional information:
* https://docs.python.org/3/tutorial/venv.html
* https://realpython.com/python-virtual-environments-a-primer/

# Usage

Run the core packet engine
Expand Down