Skip to content

Commit a340628

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 a340628

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

docs/run-from-git.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,32 @@ 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
44+
# MacOS: create virtual environment
45+
python3 -m venv ./.venv
46+
# MacOS: load virtual environment
47+
source ./.venv/bin/activate
3648
# To install required and optional dependencies
3749
# (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
50+
python3 -m pip install . # as root, or if in MacOS Virtual Environment
51+
python3 -m pip install --user . # as user
52+
# install optional dependencies
53+
python3 -m pip install .'[eyed3]' .'[gui]' .'[html5lib]' .'[mutagen]' .'[coverart]' .'[yt-dlp']
4054
# Optional: Create desktop icon
4155
python3 tools/create-desktop-icon.py
4256

@@ -47,6 +61,13 @@ As gPodder is written in Python, there is no need to compile anything or to inst
4761
bin/gpo # cli client
4862
bin/gpodder # gtk3 client
4963

64+
After that, if on MacOS, do the following:
65+
66+
cd gpodder
67+
source ./.venv/bin/activate
68+
export PYTHONPATH=./tools/fake-dbus-module/
69+
./bin/gpodder
70+
5071
## Updating
5172

5273
cd gpodder

0 commit comments

Comments
 (0)