Installation

This guide will help you install PyReporter and set up your development environment.

Requirements

PyReporter requires:

  • Python 3.14 or later
  • Poetry (for dependency management)
  • Quarto (for PDF generation)

Install Poetry

If you don’t have Poetry installed, follow the official Poetry installation guide:

curl -sSL https://install.python-poetry.org | python3 -

Install Quarto

PyReporter uses Quarto to render PDF reports. Download and install Quarto from:

https://quarto.org/docs/get-started/

Or use a package manager:

brew install quarto
# Ubuntu/Debian
sudo apt-get install quarto

# Or download from https://quarto.org/docs/download/

Download the installer from https://quarto.org/docs/download/

Install PyReporter

From Source

Clone the repository and install dependencies:

git clone <repository-url>
cd pyreporter
poetry install

This will install all required dependencies including pandas, plotnine, and quarto integration.

Development Dependencies

To install development dependencies (including documentation tools):

poetry install --with dev,docs

Configure LimeSurvey Credentials

PyReporter connects to LimeSurvey via its JSON-RPC API. You need to configure your credentials:

  1. Copy the example environment file:
cp .env.example .env
  1. Edit .env with your LimeSurvey credentials:
LIME_API_URL=https://your-limesurvey-instance.com/admin/remotecontrol
LIME_USERNAME=your_username
LIME_PASSWORD=your_password
Warning

Never commit your .env file to version control. It contains sensitive credentials.

Verify Installation

Test that everything is installed correctly:

# Test the package imports
poetry run python -c "from pyreporter import MetaRepository; print('✓ Import successful')"

# Test Quarto is available
quarto --version

Next Steps

Now that PyReporter is installed, continue to Getting Started to learn how to generate your first report.