Skip to content

Update run-from-git instructions #64

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.

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
46 changes: 40 additions & 6 deletions docs/run-from-git.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand All @@ -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
Expand Down