Survey123Py Documentation

Survey123Py is a Python library that converts YAML survey definitions into Survey123-compatible Excel files. It simplifies form creation by replacing Excel’s 40+ column workflow with readable YAML configuration files.

Contents:

• Installation
  • Requirements
  • Install from GitHub
  • Development Installation
  • Dependencies
• Quick Start Guide
  • Basic Usage
  • Command Line Usage
  • YAML Structure
  • Testing Your Survey
• YAML Construction Guide
  • Overview
  • Understanding the “-” Syntax
  • Excel Column Mappings
  • YAML Structure Examples
  • Advanced Features
  • Testing and Preview
  • Common Patterns
  • Best Practices
  • Common Errors to Avoid
  • Example Complete Survey
• Publishing Surveys
  • Installation
  • Quick Start
  • Authentication
  • CLI Commands
  • Python API
  • Advanced Configuration
  • Examples
  • Error Handling
  • Best Practices
  • Troubleshooting
• API Reference
  • Core Classes
  • Constants

Features

• Convert YAML survey definitions to Survey123-compatible Excel files

• Simplified form creation workflow

• Support for Survey123 version 3.22

• Formula support with comprehensive operators

• Preview functionality for testing surveys

Installation

Install Survey123Py directly from GitHub:

pip install git+https://github.com/pbrotoisworo/survey123py.git

Quick Start

Create a YAML file with your survey definition and convert it to Excel:

python main.py -v 3.22 --input sample_survey.yaml --output custom_output.xlsx

Indices and tables

• Index

• Module Index

• Search Page