From caaa8dc14aa521972d4c514723bbb27737fcd2d8 Mon Sep 17 00:00:00 2001 From: Dana Conrad Date: Sat, 28 Jun 2025 11:21:29 -0500 Subject: [PATCH 1/2] Update run-from-git instructions With the switch fromm requirements.txt to pyproject.toml, the instructions no longer were accurate. Also add instructions on how to use virtual environment and how to install optional dependencies. --- docs/run-from-git.md | 46 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 40 insertions(+), 6 deletions(-) diff --git a/docs/run-from-git.md b/docs/run-from-git.md index 851536c..231e53e 100644 --- a/docs/run-from-git.md +++ b/docs/run-from-git.md @@ -2,7 +2,7 @@ title: Run from Git --- -If you are on Linux and want to try out the latest version of gPodder, it is easy to do by cloning from Git. You only need Python, PyGObject3, Gtk3 and Git installed, all other dependencies can be installed into the Git checkout. +If you want to try out the latest version of gPodder or help develop, it is easy to clone from Git. You only need Python, PyGObject3, Gtk3 and Git installed, all other dependencies can be installed into the Git checkout. ## Do I need `root`, compile anything or install it system-wide? @@ -25,28 +25,62 @@ As gPodder is written in Python, there is no need to compile anything or to inst ## Optional Dependencies +Defined in pyproject.toml: + +* eyed3 +* PySocks * html5lib * mutagen +* filelock +* pillow * yt-dlp ## Instructions +First time setup: + git clone https://github.com/gpodder/gpodder.git cd gpodder - # To install required and optional dependencies - # (not including git, python or gtk3 dependencies) - python3 -m pip install -r tools/requirements.txt # as root - python3 -m pip install --user -r tools/requirements.txt # as user + + # Optional: create virtual environment (required on MacOS) + python3 -m venv ./.venv + # load virtual environment, if using one + source ./.venv/bin/activate + + # Select one of the following four steps to install dependencies: + # (does not install git, python or gtk3 dependencies) + + # required dependencies only (as root, or if in virtual environment) + python3 -m pip install . + # required dependencies only (as user) + python3 -m pip install --user . + # required and optional dependencies (as root, or if in virtual environment) + python3 -m pip install '.[eyed3,gui,html5lib,mutagen,coverart,yt-dlp]' + # required and optional dependencies (as user) + python3 -m pip install --user '.[eyed3,gui,html5lib,mutagen,coverart,yt-dlp]' + # Optional: Create desktop icon python3 tools/create-desktop-icon.py - # Windows and Mac need the fake dbus module + # Windows and Mac: add the fake debus module to the python path export PYTHONPATH=./tools/fake-dbus-module/ # To directly launch from command line bin/gpo # cli client bin/gpodder # gtk3 client +The next time you wish to run gPodder, do the following: + + cd gpodder + + # if using a virtual environment + source ./.venv/bin/activate + + # if on Windows or Mac + export PYTHONPATH=./tools/fake-dbus-module/ + + ./bin/gpodder + ## Updating cd gpodder From 58e3fa0175a7c2b96cf851529f3c087aa05f22ea Mon Sep 17 00:00:00 2001 From: dconrad5 Date: Sun, 17 Aug 2025 16:10:57 -0500 Subject: [PATCH 2/2] Update docs/run-from-git.md typo Co-authored-by: Eric Le Lay <222469+elelay@users.noreply.github.com> --- docs/run-from-git.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/run-from-git.md b/docs/run-from-git.md index 231e53e..c1adbfd 100644 --- a/docs/run-from-git.md +++ b/docs/run-from-git.md @@ -62,7 +62,7 @@ First time setup: # Optional: Create desktop icon python3 tools/create-desktop-icon.py - # Windows and Mac: add the fake debus module to the python path + # Windows and Mac: add the fake dbus module to the python path export PYTHONPATH=./tools/fake-dbus-module/ # To directly launch from command line