Skip to content

Commit caaa8dc

Browse files
committed
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.
1 parent c4fd2a0 commit caaa8dc

File tree

1 file changed

+40
-6
lines changed

1 file changed

+40
-6
lines changed

docs/run-from-git.md

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Run from Git
33
---
44

5-
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.
5+
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.
66

77
## Do I need `root`, compile anything or install it system-wide?
88

@@ -25,28 +25,62 @@ As gPodder is written in Python, there is no need to compile anything or to inst
2525

2626
## Optional Dependencies
2727

28+
Defined in pyproject.toml:
29+
30+
* eyed3
31+
* PySocks
2832
* html5lib
2933
* mutagen
34+
* filelock
35+
* pillow
3036
* yt-dlp
3137

3238
## Instructions
3339

40+
First time setup:
41+
3442
git clone https://github.com/gpodder/gpodder.git
3543
cd gpodder
36-
# To install required and optional dependencies
37-
# (not including git, python or gtk3 dependencies)
38-
python3 -m pip install -r tools/requirements.txt # as root
39-
python3 -m pip install --user -r tools/requirements.txt # as user
44+
45+
# Optional: create virtual environment (required on MacOS)
46+
python3 -m venv ./.venv
47+
# load virtual environment, if using one
48+
source ./.venv/bin/activate
49+
50+
# Select one of the following four steps to install dependencies:
51+
# (does not install git, python or gtk3 dependencies)
52+
53+
# required dependencies only (as root, or if in virtual environment)
54+
python3 -m pip install .
55+
# required dependencies only (as user)
56+
python3 -m pip install --user .
57+
# required and optional dependencies (as root, or if in virtual environment)
58+
python3 -m pip install '.[eyed3,gui,html5lib,mutagen,coverart,yt-dlp]'
59+
# required and optional dependencies (as user)
60+
python3 -m pip install --user '.[eyed3,gui,html5lib,mutagen,coverart,yt-dlp]'
61+
4062
# Optional: Create desktop icon
4163
python3 tools/create-desktop-icon.py
4264

43-
# Windows and Mac need the fake dbus module
65+
# Windows and Mac: add the fake debus module to the python path
4466
export PYTHONPATH=./tools/fake-dbus-module/
4567

4668
# To directly launch from command line
4769
bin/gpo # cli client
4870
bin/gpodder # gtk3 client
4971

72+
The next time you wish to run gPodder, do the following:
73+
74+
cd gpodder
75+
76+
# if using a virtual environment
77+
source ./.venv/bin/activate
78+
79+
# if on Windows or Mac
80+
export PYTHONPATH=./tools/fake-dbus-module/
81+
82+
./bin/gpodder
83+
5084
## Updating
5185

5286
cd gpodder

0 commit comments

Comments
 (0)