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:

Features

  • Convert YAML survey definitions to Survey123-compatible Excel files

  • Convert existing Excel files back to YAML format for editing and version control

  • Direct publishing to ArcGIS Online/Enterprise

  • Simplified form creation workflow with YAML

  • Support for Survey123 version 3.22

  • Comprehensive formula and calculation support

  • Advanced testing and preview functionality with survey123py::preview_input

  • Command-line interface for automation

  • Python API for programmatic use

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