propresenter-client 0.1.0

Python client for the ProPresenter REST API

propresenter-client

Python client for the ProPresenter REST API.

Description

A Python library and CLI for interacting with ProPresenter's REST API. Provides a ProPresenterController class for programmatic access to any ProPresenter API endpoint, plus an interactive presentation mode CLI for live slide control.

Features

• ProPresenterController class covering common ProPresenter API endpoints
• Interactive presentation mode for live slide navigation
• Extensible design — add new API endpoints as methods over time

Installation

pip install propresenter-client

Development Setup

# Create a virtual environment and install the package with dev dependencies
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

# Run the CLI
propresenter-client --host=<your-host>

Quick Start

from propresenter_client import ProPresenterController

controller = ProPresenterController(host="localhost", port=1025)

# Slide control
controller.next_slide()
controller.previous_slide()
controller.go_to_slide(1)  # 1-indexed

# Presentations
controller.activate_presentation("92B5E6E2-5E99-4F54-BAD3-6FBD7D2EE675")
controller.get_presentation_details("92B5E6E2-5E99-4F54-BAD3-6FBD7D2EE675")
controller.activate_first_library_presentation("Default")

Interactive Presentation Mode

# Default: activates first presentation in Default library
propresenter-client --host=192.168.1.100

# Activate a specific presentation by name before entering interactive mode
propresenter-client --host=192.168.1.100 --presentation="Amazing Grace"

# Print presentation details and exit (no interactive mode)
propresenter-client --host=192.168.1.100 --presentation="Amazing Grace" --list-details

# Use a different library
propresenter-client --host=192.168.1.100 --library="Worship"

# Enable request diagnostics
propresenter-client --host=192.168.1.100 --log-level=DEBUG

Interactive commands (no Enter required for single-key commands):

• n — Next slide
• b — Back to previous slide
• q — Quit
• 1, 2, 3, … — Go to specific slide (1-indexed, press Enter to confirm)
• Escape — Cancel a partially typed slide number

Testing

# Run all tests
pytest

# Run specific test file
pytest tests/test_propresenter_controller.py -v

# Run specific test class
pytest tests/test_propresenter_controller.py::TestProPresenterController -v

# Run individual test
pytest tests/test_propresenter_controller.py::TestProPresenterController::test_get_status_success -v

# Run tests matching a pattern
pytest -k "test_get" -v

# Generate coverage report
pytest --cov=propresenter_client

Releasing

Releases are published to PyPI automatically by the Publish GitHub Actions workflow when a version tag is pushed. The version number is derived from the git tag via setuptools_scm.

git tag v1.2.3
git push origin v1.2.3

Publishing uses PyPI Trusted Publishing (OIDC), so no API tokens are stored in the repository. One-time setup on PyPI:

1. Create the project's pending publisher at https://pypi.org/manage/account/publishing/.
2. Owner: scaperothian, repository: propresenter-client, workflow: publish.yml, environment: pypi.

Requirements

• Python 3.10+
• requests

License

MIT