### PyRadio Installation Guides

Source: https://github.com/coderholic/pyradio/blob/master/docs/build.html

Links to OS-specific installation guides for PyRadio. It highlights the difference between the older 'pip installation' and the newer 'pipx installation' methods for Linux.

```text
1. Linux
    * pip installation (the old way)  
        Not valid for Debian and Ubuntu 23.04
    * pipx installation (the new way)  
        Valid for Debian and Ubuntu 23.04 and newer
2. MacOS  
    Follow the instructions on [this page](macos.html).
3. Windows  
    Follow the instructions on [this page](windows.html).
```

--------------------------------

### Initial Installation Command

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

The standard command to install PyRadio using the install.py script.

```APIDOC
python install.py
```

--------------------------------

### Install PyRadio

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

These commands demonstrate the process of installing PyRadio. It involves downloading the install script and then executing it using the Python interpreter.

```shell
cd %USERPROFILE%
python install.py
```

--------------------------------

### PyRadio Installation Error Example

Source: https://github.com/coderholic/pyradio/blob/master/docs/build.md

This snippet shows a typical error message encountered on systems with 'externally-managed-environments', guiding users to install pipx or use virtual environments for PyRadio installation.

```text
error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
    python3-xyz, where xyz is the package you are trying to
    install.

    If you wish to install a non-Debian-packaged Python package, 
    create a virtual environment using python3 -m venv path/to/venv.
    Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make 
    sure you have python3-full installed.

    If you wish to install a non-Debian packaged Python application, 
    it may be easiest to use pipx install xyz, which will manage a 
    virtual environment for you. Make sure you have pipx installed.

    See /usr/share/doc/python3.11/README.venv [1] for more information.

--
[1] https://sources.debian.org/src/python3.11/3.11.2-6/debian/README.venv
```

--------------------------------

### Download PyRadio Installation Script

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.md

Downloads the PyRadio installation script from its GitHub repository.

```bash
cd
curl -L \
    https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py \
    -o install.py
```

--------------------------------

### Download and Install PyRadio

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.md

Downloads the PyRadio installation script using curl and executes it with python3.

```bash
cd
curl -L \
    https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py \
    -o install.py
python3 install.py
```

--------------------------------

### Execute PyRadio Installation

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.html

Runs the downloaded PyRadio installation script.

```python
python3 install.py
```

--------------------------------

### Download PyRadio Installation Script

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.html

This command downloads the PyRadio installation script from GitHub using curl.

```bash
cd
curl -L \
    https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py \
    -o install.py
```

--------------------------------

### Setup pre-commit Git Hook

Source: https://github.com/coderholic/pyradio/blob/master/devel/README.md

Install the pre-commit git hook, which is used to create README.html. This hook requires pandoc to be installed. If pandoc is not present, commits will fail. Link the hook to your .git/hooks directory.

```bash
ln -s devel/pre-commit .git/hooks/pre-commit
```

--------------------------------

### Pipx Installation and Path Setup

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux-pipx.html

Installs pipx and ensures its executable path is set up correctly for use.

```bash
sudo apt-get install pipx
python3 -m pip install pipx
python3 -m pipx ensurepath
```

```bash
sudo dnf install python3-pip python3-wheel python3-rich python3-requests python3-netifaces pipx
python3 -m pipx ensurepath
```

```bash
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```

--------------------------------

### Download PyRadio Installation Script

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux.md

Downloads the PyRadio installation script from GitHub using either wget or curl. Includes an option to modify the script for Python 2 compatibility.

```bash
cd
wget https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py

or using curl:

cd
curl -L \
    https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py \
    -o install.py

If you are going to use **Python 2**, please execute:

sed -i.orig 's/from rich import print/pass/' install.py
```

--------------------------------

### Install Homebrew

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.md

Installs the Homebrew package manager on macOS by executing a script from GitHub.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Download and Execute PyRadio Install Script

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.html

Downloads the install.py script from GitHub and executes it using Python 3.

```Bash
cd
curl -L \
    https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py \
    -o install.py
python3 install.py
```

--------------------------------

### Install Media Player (Linux)

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux.md

Installs one of the required media players (mpv, mplayer, or vlc) on Debian, Fedora, or openSUSE systems using their respective package managers.

```bash
# on Debian
sudo apt-get install [ mpv / mplayer / vlc ]

# on Fedora
sudo dnf install [ mpv / mplayer / vlc ]

# on openSUSE
sudo zypper install [ mpv / mplayer / vlc ]
```

--------------------------------

### Install Homebrew

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.html

Command to install Homebrew, a package manager for macOS, which is a prerequisite for installing Python and other tools.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Install pipx and dependencies (Debian/Ubuntu)

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.md

Installs pipx and necessary Python packages for PyRadio installation on Debian-based systems.

```bash
sudo apt-get install python3-full python3-pip python3-venv pipx
```

--------------------------------

### Install PyRadio on openSUSE and Derivatives

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux.md

Installs PyRadio and its Python 3 dependencies on openSUSE-based systems. Requires specific python310 packages and other python3 packages.

```bash
sudo zypper install \
    python310-requests \
    python310-rich \
    python3-psutil \
    python3-dnspython \
    python3-dateutil \
    python3-netifaces
cd
python3 install.py
```

--------------------------------

### Ensure pipx Path and Perform Installation

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.md

Ensures pipx is in the system's PATH and then executes the downloaded PyRadio installation script.

```bash
python3 -m pipx ensurepath
source ~/.zshrc
python3 install.py
```

--------------------------------

### Install MPV or MPlayer with Homebrew

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.md

Installs either MPV or MPlayer media players using Homebrew.

```bash
brew install mpv
```

```bash
brew install mplayer
```

--------------------------------

### Install MPV or MPlayer using Homebrew

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.html

Instructions for installing MPV or MPlayer media players using the Homebrew package manager on macOS.

```bash
brew install mpv
```

```bash
brew install mplayer
```

--------------------------------

### PyRadio Basic Usage

Source: https://github.com/coderholic/pyradio/blob/master/README.md

This snippet outlines the basic commands for interacting with the PyRadio command-line interface after installation. It covers starting the player, navigating stations, adjusting volume, accessing help, exiting, and using the RadioBrowser directory.

```bash
pyradio

# Navigation:
# Arrow keys to select station
# ENTER to play

# Volume:
# + or . to increase volume
# - or , to decrease volume
# v to save volume

# Help:
# ? for help screens
# \h for HTML help pages

# Exit:
# Esc or q

# RadioBrowser:
# O to access RadioBrowser online directory

# Theming:
# t to get a list of themes
# Right arrow to activate selected theme
# Space to make theme default
```

--------------------------------

### Install PyRadio Dependencies

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.html

Installs necessary Python dependencies for PyRadio using pip and ensures the pipx path is set.

```python
python3 -m pip install requests rich pipx --break-system-packages
python3 -m pipx ensurepath
source ~/.zshrc
```

--------------------------------

### Install VLC Media Player

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.html

This snippet shows how to create a symbolic link for VLC to be used with PyRadio after installing it from its official website.

```bash
ln -s /Applications/VLC.app/Contents/MacOS/VLC ~/.local/bin/cvlc
```

--------------------------------

### Install PyRadio Dependencies

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.md

Installs necessary Python dependencies for PyRadio, including requests, rich, and pipx, using pip.

```bash
python3 -m pip install requests rich pipx --break-system-packages
```

--------------------------------

### Install Python on Windows

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

Instructions for installing Python on Windows, emphasizing the custom installation option to add Python to environment variables. It also suggests checking the zephyrproject-rtos/windows-curses GitHub page for the latest supported Python version.

```bash
# Download Python 3.x from https://www.python.org/downloads/windows/
# During installation, select 'Custom Installation' and check 'Add Python to environment variables'.
```

--------------------------------

### Install PyRadio on openSUSE

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux-pipx.html

Installs PyRadio on openSUSE and its derivatives. This includes installing system dependencies and then running the installation script.

```bash
sudo zypper install python3-psutil python3-dnspython python3-dateutil python3-netifaces
cd
python3 install.py
```

--------------------------------

### Install PyRadio on Debian and Derivatives

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux.md

Installs PyRadio and its Python 3 dependencies on Debian-based systems. Requires python3-full, python3-pip, and several other python3 packages.

```bash
sudo apt-get install \
    python3-full \
    python3-pip \
    python3-rich \
    python3-requests \
    python3-dnspython \
    python3-psutil \
    python3-netifaces \
    python3-dateutil
cd
python3 install.py
```

--------------------------------

### Install PyRadio on openSUSE

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux.html

Installs PyRadio on openSUSE systems using zypper. This includes installing necessary Python packages and then running the installation script.

```bash
sudo zypper install python310-requests python310-rich python3-psutil python3-dnspython python3-dateutil python3-netifaces
cd
python3 install.py
```

--------------------------------

### Install PyRadio on Fedora and Derivatives

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux.md

Installs PyRadio and its Python 3 dependencies on Fedora-based systems. Requires python3-pip, python3-wheel, and several other python3 packages.

```bash
sudo dnf install \
    python3-pip \
    python3-wheel \
    python3-rich \
    python3-requests \
    python3-netifaces \
    python3-psutil \
    python3-dns \
    python3-dateutil
cd
python install.py
```

--------------------------------

### Manage PyRadio Version Tags

Source: https://github.com/coderholic/pyradio/blob/master/devel/README.md

Use the 'what_tag' script to help create local version tags for PyRadio and commit them upstream. This script assists in the process by reading the package version from pyradio/__init__.py and guiding manual commit actions.

```bash
devel/what_tag
```

--------------------------------

### PyRadio Version 0.9.2.20 - Documentation and Setup Updates

Source: https://github.com/coderholic/pyradio/blob/master/docs/index.html

This version includes updates to the documentation structure, moving files to a 'docs' folder, and revising `pyproject.toml` and `setup.py` for installation method changes.

```Python
# Creating the docs folder and moving files there
# Updating pyproject.toml and setup.py for the latest
# Installation method changes
# Working on scheduler (not applicable yet)
# Updating docs
```

--------------------------------

### PyRadio Executable Paths

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

Displays the system and user paths for the PyRadio executable, useful for adding it to the PATH environment variable.

```APIDOC
PyRadio EXE files:
  System:
    %PROGRAMFILES%\Python310\Scripts\pyradio.exe
  User:
    %APPDATA%\Python\Python310\Scripts\pyradio.exe
```

--------------------------------

### Link VLC Executable

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.md

Creates a symbolic link for the VLC executable to be accessible system-wide for PyRadio.

```bash
ln -s /Applications/VLC.app/Contents/MacOS/VLC ~/.local/bin/cvlc
```

--------------------------------

### System Dependencies Installation on openSUSE

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux-pipx.md

Installs necessary system dependencies for PyRadio on openSUSE using zypper.

```bash
sudo zypper install \
    python3-psutil \
    python3-dnspython \
    python3-dateutil \
    python3-netifaces
```

--------------------------------

### Download PyRadio Installation Script

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux-pipx.md

Downloads the PyRadio installation script from GitHub using either wget or curl.

```bash
cd
wget https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py
```

```bash
cd
curl -L \
    https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py \
    -o install.py
```

--------------------------------

### Download PyRadio Installation Script

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux.html

Downloads the PyRadio installation script using either wget or curl. This script is used to install PyRadio and its dependencies.

```bash
cd
wget https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py
```

```bash
cd
curl -L \
    https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py \
    -o install.py
```

--------------------------------

### Install PyRadio on Debian

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux-pipx.html

Installs PyRadio on Debian and its derivatives. This includes installing system dependencies and then running the installation script.

```bash
sudo apt-get install python3-dnspython python3-psutil python3-netifaces python3-dateutil
cd
python3 install.py
```

--------------------------------

### MPV Installation Steps

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows-mpv.html

This section outlines the process of downloading and setting up the MPV player on a Windows system. It includes navigating to the correct download pages, selecting the appropriate build (git or release, 32-bit or 64-bit), and extracting the archive.

```Documentation
1. Go to MPV’s home page (http://mpv.io).
2. Navigate to the Installation page.
3. Click the 'Windows builds by shinchiro (releases and git)' link on SourceForge.
4. Choose either the git version (64bit or 32bit) or the latest stable release (64bit or 32bit).
5. Download the 7z archive.
6. Extract the archive to a desired location.
7. Rename the extracted directory to 'mpv'.
```

--------------------------------

### PyRadio Linux Installation Options

Source: https://github.com/coderholic/pyradio/blob/master/docs/build.md

Details the installation methods for PyRadio on Linux systems. It differentiates between the traditional pip installation (not valid for Debian/Ubuntu 23.04) and the recommended pipx installation (valid for Debian/Ubuntu 23.04 and newer).

```Markdown
1. Linux
    - [pip installation](linux.md) (the old way) \
Not valid for **Debian** and **Ubuntu 23.04**
    - [pipx installation](linux-pipx.md) (the new way) \
Valid for **Debian** and **Ubuntu 23.04** and newer
```

--------------------------------

### Download PyRadio Installation Script

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux-pipx.html

Downloads the PyRadio installation script using wget or curl.

```bash
cd
wget https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py
```

```bash
cd
curl -L \
    https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py \
    -o install.py
```

--------------------------------

### PyRadio Desktop File Installation

Source: https://github.com/coderholic/pyradio/blob/master/docs/index.html

Describes how PyRadio installs a desktop file, its default location, how it appears in application menus, and how to handle local vs. system-wide installations.

```documentation
**PyRadio** will install a Desktop File under **~/.local/share/applications**.

**Note:** The system wide Desktop File will probably be under **/usr/share/applications** or **/usr/local/share/applications**.

By default, this Desktop File will add a “**PyRadio**” entry under the “**Internet**” category (or menu), and will execute **PyRadio** no matter if the directory it resides in is the PATH or not, using the **default** terminal that the system uses.

In case of a local installation, when a system wide installation also exists, the entry will display “**PyRadio - Local**” to distinguish itself from the system wide “**PyRadio**” one.
```

--------------------------------

### Install pipx and Dependencies (Debian/Ubuntu)

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.html

Installs pipx and necessary Python packages for PyRadio installation on Debian-based systems.

```Bash
sudo apt-get install python3-full python3-pip python3-venv pipx
```

--------------------------------

### PyRadio Client Usage Examples

Source: https://github.com/coderholic/pyradio/blob/master/docs/client.html

Demonstrates how to use the pyradio-client to list available servers and send commands to a specific server instance.

```bash
$ pyradio-client --addr

PyRadio Remote Control Server
  Headless server: 127.0.0.1:11111
  Server: 127.0.0.1:9998

pyradio-client -s 127.0.0.1:9998 i
```

--------------------------------

### Starting and Monitoring the PyRadio Server

Source: https://github.com/coderholic/pyradio/blob/master/docs/server.html

Instructions on how to start the PyRadio Remote Control Server and view its status.

```APIDOC
Starting the server:
  - Automatically: Set 'Auto-start Server' to True in the config file.
  - Manually: Press '\s' in the main PyRadio window, select options, and press 's'.

Monitoring server status:
  - After starting, pressing '\s' displays the server's Text and Web addresses.
```

--------------------------------

### PyRadio Command Line Options

Source: https://github.com/coderholic/pyradio/blob/master/docs/index.html

Lists the available command-line options for PyRadio, including help, configuration, playback, playlist management, theming, and more.

```bash
# pyradio -h

Usage: pyradio [-h] [-c CONFIG_DIR] [-p [STATION_NUMBER]] [-x] [-u PLAYER]
               [-l] [-lt] [-sds] [-sd] [-od] [-pc] [-d]
               [--d-player-input D_PLAYER_INPUT] [-ul] [-us] [-U] [-R] [-V]
               [-ls] [-s PLAYLIST] [-tlp] [-t THEME] [--show-themes]
               [--no-themes] [--write-theme IN_THEME OUT_THEME,]
               [--terminal TERMINAL] [--terminal-param ...]
               [-oc] [-sc] [-cc]
               [-gc] [-r] [-or] [-lr] [-mkv MKV_FILE] [-scv PNG_FILE] [-srt]
               [-ach] [--headless IP_AND_PORT] [--address] [-fd]

Curses based Internet Radio Player

General options:
  -h, --help            Show this help message and exit
  -c CONFIG_DIR, --config-dir CONFIG_DIR
                        Use specified configuration directory instead of the
```

--------------------------------

### Update PyRadio (0.9.2.5)

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.md

Installs the python3-dateutil package, required for updating PyRadio installations from version 0.9.2.5.

```bash
sudo apt-get install python3-dateutil
```

--------------------------------

### Uninstall PyRadio

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.md

Command to uninstall the current PyRadio installation.

```bash
pyradio -R
```

--------------------------------

### Uninstall PyRadio

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.html

Command to uninstall the current PyRadio installation.

```Bash
pyradio -R
```

--------------------------------

### Install PyRadio

Source: https://github.com/coderholic/pyradio/blob/master/devel/README.md

Build and install PyRadio using the system's default Python or explicitly specifying Python 2.x or 3.x. Run 'devel/build_install_pyradio -h' for available options.

```bash
devel/build_install_pyradio -h
```

--------------------------------

### Starting Recording from Command Line

Source: https://github.com/coderholic/pyradio/blob/master/docs/recording.md

The `--record` command-line parameter can be used to start PyRadio in recording mode. This is useful for simultaneously starting playback and recording a specific station.

```text
Command-line parameter to start in recording mode: --record
Example: pyradio -p 3 --record
This starts playback and recording of station 3.
```

--------------------------------

### Force Update for Pre 0.8.9 Installations

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

Command to force an update for PyRadio installations older than version 0.8.9. This involves adding the '--force' parameter to the installation command.

```APIDOC
python install.py --force
```

--------------------------------

### Raspberry Pi PyRadio Installation Notes

Source: https://github.com/coderholic/pyradio/blob/master/docs/build.md

Specific considerations for installing and running PyRadio on a Raspberry Pi. Highlights the default player (MPlayer) and provides guidance for using MPV, including potential connection timeout adjustments and system stability warnings for lower-end machines.

```Markdown
### Rasberry Pi installation

If installing on a Rasberry Pi, there are a couple of things you should be aware of:

1. The default player will be **MPlayer**
3. If you still want to use **MPV**, please make sure you increase the *Connection timeout* value to at least 20 (sometimes even 30 for some machines). Even then, your machine may eventually crash, if it's on the lower end of things and **PyRadio** is left running for hours.
```

--------------------------------

### PyRadio Windows Installation

Source: https://github.com/coderholic/pyradio/blob/master/docs/build.md

Instructions for installing PyRadio on Windows systems, directing users to a specific external page for detailed guidance.

```Markdown
3. Windows \
Follow the instructions on [this page](windows.md).
```

--------------------------------

### Install Python 3 with Homebrew

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.md

Installs Python 3 using Homebrew and updates the system's PATH to prioritize the Homebrew-installed Python.

```bash
brew install python3
cat << END >> ~/.zshrc
export PATH=/usr/local/bin:"$PATH"
END
source ~/.zshrc
```

--------------------------------

### PyRadio Client Server Detection Example

Source: https://github.com/coderholic/pyradio/blob/master/docs/client.md

Demonstrates how to list available PyRadio remote control servers and their addresses using the --addr command.

```bash
$ pyradio-client --addr

PyRadio Remote Control Server
  Headless server: 127.0.0.1:11111
  Server: 127.0.0.1:9998

```

--------------------------------

### Re-execute PyRadio Installation Script

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

This message indicates that the PyRadio installation script needs to be executed a second time to properly load installed Python modules. It provides the command to re-run the script.

```shell
PyRadio has installed all required python modules.
In order for them to be properly loaded, the installation script
has to be executed afresh.

Please execute the installation script again, like so:

    python install.py
```

--------------------------------

### PyRadio Dependencies

Source: https://github.com/coderholic/pyradio/blob/master/docs/packaging.html

Lists the required media players (mpv, plmayer, vlc) and Python modules (requests, dnspython, psutil, rich, netifaces, dateutil) for PyRadio.

```Markdown
1. mpv
2. plmayer
3. vlc

1. requests
2. dnspython
3. psutil
4. rich
5. netifaces
6. dateutil
```

--------------------------------

### Install Python 3 with Homebrew

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.html

Command to install the latest version of Python 3 using Homebrew. This also installs Apple's Command Line Developer Tools if they are not already present.

```bash
brew install python3
```

--------------------------------

### PyRadio MacOS Installation

Source: https://github.com/coderholic/pyradio/blob/master/docs/build.md

Instructions for installing PyRadio on MacOS systems, directing users to a specific external page for detailed guidance.

```Markdown
2. MacOS \
Follow the instructions on [this page](macos.md).
```

--------------------------------

### PyRadio Installation Methods

Source: https://github.com/coderholic/pyradio/blob/master/docs/build.html

Details the installation methods for PyRadio across different operating systems. It highlights the recommended use of pipx on Linux and macOS for Python 3, while Windows installations continue to use the standard pip method. It also mentions fallback options for systems without pipx.

```text
PyRadio will be installed by default through pipx on Linux, if pipx is already installed.
If a Linux distribution does not provide a pipx package, you can still use the pip installation method.
PyRadio on Windows will still use the pip installation method.
PyRadio will only be installed using pipx on Python 3 on MacOS.
```

--------------------------------

### PyRadio Help and Customization

Source: https://github.com/coderholic/pyradio/blob/master/docs/index.html

Details how to access PyRadio's offline HTML help and information on customizing key bindings through the configuration window.

```APIDOC
Action | Description
-------|----------
\h | Open offline HTML help from the main window.
Configuration Window -> Keyboard Shortcuts | Access and customize key bindings. Refer to the help screen ('*?') within this section.
```

--------------------------------

### Update Dependency for PyRadio 0.9.2.5

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.html

Installs the python3-dateutil package, required for updating PyRadio from version 0.9.2.5.

```Bash
sudo apt-get install python3-dateutil
```

--------------------------------

### Verify Python Installation

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

This snippet shows the expected output when verifying a Python installation in a Windows console. If the command 'python' is recognized and displays version information, the installation is successful and Python is in the system's PATH.

```shell
Python 3.6.4 (v3.6.4:d48eceb, Dec 19 2017, 06:54:40) [MSC v.1900 64 bit (AMD64)] on win
Type "help", "copyright", "credits" or "license" for more information.
>>>
```

--------------------------------

### PyRadio Command Line Recording

Source: https://github.com/coderholic/pyradio/blob/master/docs/recording.html

Demonstrates how to start PyRadio in recording mode using the '--record' command-line parameter.

```Shell
pyradio -p 3 --record
```

--------------------------------

### MKVToolNix Installation Benefits and Linux Instructions

Source: https://github.com/coderholic/pyradio/blob/master/docs/recording.md

Explains the advantages of installing MKVToolNix for embedding song titles and enabling chapter navigation in recordings. It also provides instructions for installing MKVToolNix on Linux systems.

```Documentation
Why would I want to install yet another package / program, you may ask.
Here's why:
1. Through **MKVToolNix** it is possible to have the songs titles embedded in the recorded file itself.
2. If the player used to reproduce the recorded file is chapters aware (most are), you can also navigate to the songs; their titles will be availabe at the **Chapters** menu (wherever the application chooses to place it).
3. If your player of choice for **PyRadio** is **MPlayer**, you really should take the time to install **MKVToolNix**. 
   The reason is that **MPlayer** will dump the audio data it receives to the file without any alteration. This means that even though the saved file will have the *mkv* extension, the file will not be a valid Mastroka file; it will be an MP3, a FLAC, a AAC or whatever encoding is used by the station. 
   Using **MKVToolNix** to add chapters to the file will actually create a valid **mkv** file.

On **Linux** you will have no problem installing the package; all distros will include it, either as *mkvtoolnix*, or *mkvtoolnix-cli* or whatever.
Just make sure that after the installation you can execute **mkvmerge** from a terminal.
```

--------------------------------

### Start PyRadio Headless with screen (Openbox)

Source: https://github.com/coderholic/pyradio/blob/master/docs/headless.md

Adds a command to the Openbox autostart file to launch PyRadio in a headless screen session after a 10-second delay. This is suitable for window manager environments.

```bash
echo "(sleep 10; /usr/bin/screen -U -S pyradio-session -d -m /home/spiros/.local/bin/pyradio --headless auto)" >> ~/.config/openbox/autostart
```

--------------------------------

### Update PATH for Python

Source: https://github.com/coderholic/pyradio/blob/master/docs/macos.html

Appends the Homebrew Python binary directory to the Zsh configuration file to ensure the newly installed Python is the default. The change is then sourced to apply it to the current session.

```bash
cat << END >> ~/.zshrc
export PATH=/usr/local/bin:"$PATH"
END
source ~/.zshrc
```

--------------------------------

### Ensure pipx path

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.md

Configures the system's PATH to include pipx executables.

```bash
python3 -m pipx ensurepath
```

--------------------------------

### PyRadio Client Command Line Parameters

Source: https://github.com/coderholic/pyradio/blob/master/docs/client.md

Displays the usage and available command-line options for the pyradio-client, including general options, server parameters, and command arguments.

```bash
Usage: pyradio-client [-h] [--address] [-s SERVER_AND_PORT] [-r] [-t TIMEOUT]
                      [command]

PyRadio Remote Control Client

General options:
  -h, --help            Show this help message and exit
  --address             List available servers

Server Parameters:
  -s SERVER_AND_PORT, --server_and_port SERVER_AND_PORT
                        Set the server IP and PORT (format: IP:PORT)
  -r, --reverse-detection
                        Reverse server detection (when no server IP and PORT
                        specified); detect headless server last, instead of
                        headless server first
  -t TIMEOUT, --timeout TIMEOUT
                        Set the timeout (default = 1.0)
  command               The command to send to the server

```

--------------------------------

### PyRadio Player Management Menu

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

This code block represents the interactive menu presented by PyRadio when managing media players (MPV, MPlayer). Users can select options to update, install, or uninstall these players.

```shell
Reading config...
Reading playlist...

Please select an action:
    1. Update MPV
    2. Install MPlayer

    3. Uninstall MPV

    Note:
      VLC media player is already installed

Press 1, 2, 3 or q to Cancel:
```

--------------------------------

### PyRadio Man Page and Documentation Files

Source: https://github.com/coderholic/pyradio/blob/master/docs/index.html

Adds 'buffering.md' and 'pyradio_buf' man page, and updates existing documentation.

```python
# adding bufferring.md and pyradio_buf man page
# updating docs
```

--------------------------------

### Using base16 Themes with PyRadio

Source: https://github.com/coderholic/pyradio/blob/master/docs/themes.html

Explains how to use base16 themes with PyRadio, including the availability of over 900 themes and the option to activate or watch them. Also covers using base16 themes without installing base16 itself.

```APIDOC
base16 Integration:
  - PyRadio includes a base16 template.
  - Over 900 base16 themes are available for PyRadio.
  - Adds four entries per theme in the selection menu (main, alternatives, variants).
  - Themes can be activated or watched (PyRadio downloads and applies them).

Using themes without base16:
  - Download themes from https://github.com/edunfelt/base16-pyradio.
  - Use '_cycle_themes.py' and '_install_themes.py' scripts for inspection and installation.
  - This is the primary method for Windows users.
```

--------------------------------

### Ensure pipx Path

Source: https://github.com/coderholic/pyradio/blob/master/docs/pip-error.html

Ensures that pipx is added to the system's PATH environment variable.

```Bash
python3 -m pipx ensurepath
```

--------------------------------

### Theme.sh Theme Integration and Alternatives

Source: https://github.com/coderholic/pyradio/blob/master/docs/themes.html

PyRadio integrates with theme.sh to provide over 1800 themes. For users not using theme.sh, an alternative method involves downloading a repository and using provided Python scripts (_create_themes.py, _cycle_themes.py, _install_themes.py) to generate, inspect, and install themes. This is the primary method for Windows users.

```Shell
# Theme.sh integration
# When detected, four themes will be added to the menu; the main and the alternative forms (there are 400 plus themes available, which makes a staggering number of around 1800 themes for PyRadio!)

# Using the themes without theme.sh
# In case one wants to use any of these themes, but not install or use theme.sh, one can download this repo (https://github.com/s-n-g/theme-sh-pyradio), and use the "_create_themes.py" script to create the themes, and "_cycle_themes.py" and "_install_themes.py" scripts to inspect and install them.
# For Windows users, this is the only way to use any of these "Project Themes", since their generation works on non-windows platforms only.
```

--------------------------------

### Update PyRadio Command

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

Command to initiate an update for PyRadio. If PyRadio is not in the PATH, the full path to the executable must be used.

```APIDOC
pyradio -U
```

--------------------------------

### Generate PyRadio Debug Log

Source: https://github.com/coderholic/pyradio/blob/master/docs/windows.md

Instructions to generate a debug log file for reporting PyRadio bugs. This involves navigating to the user profile directory, deleting any existing log file, and running PyRadio with the debug flag.

```shell
cd %USERPROFILE%
del pyradio.log
pyradio -d
```

--------------------------------

### PyRadio Cache Management with install.py

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux-pipx.md

Provides commands to manage the PyRadio cache using the install.py script. This includes showing cache contents, opening the cache folder, clearing the cache, and getting the latest source code.

```bash
python install.py -sc
```

```bash
python install.py -oc
```

```bash
python install.py -cc
```

```bash
python install.py -gc
```

--------------------------------

### Install PyRadio on Fedora

Source: https://github.com/coderholic/pyradio/blob/master/docs/linux-pipx.html

Installs PyRadio on Fedora and its derivatives. This involves installing system dependencies and then executing the installation script.

```bash
sudo dnf install python3-netifaces python3-psutil python3-dns python3-dateutil
cd
python install.py
```

--------------------------------

### PyRadio Client Command Line Parameters

Source: https://github.com/coderholic/pyradio/blob/master/docs/client.html

Displays the usage and available command-line options for the pyradio-client. This includes general options like help, address listing, and server-specific parameters such as address, reverse detection, and timeout.

```bash
Usage: pyradio-client [-h] [--address] [-s SERVER_AND_PORT] [-r] [-t TIMEOUT]
                      [command]

PyRadio Remote Control Client

General options:
  -h, --help            Show this help message and exit
  --address             List available servers

Server Parameters:
  -s SERVER_AND_PORT, --server_and_port SERVER_AND_PORT
                        Set the server IP and PORT (format: IP:PORT)
  -r, --reverse-detection
                        Reverse server detection (when no server IP and PORT
                        specified); detect headless server last, instead of
                        headless server first
  -t TIMEOUT, --timeout TIMEOUT
                        Set the timeout (default = 1.0)
  command               The command to send to the server
```