Citric#

A client to the LimeSurvey Remote Control API 2, written in modern Python.

Release v1.0.1.dev23+g5367dbc. (What’s new?)

Features#

Installation#

# PyPI
pip install citric
# or conda
conda install -c conda-forge citric

Usage#

from citric import Client

# Connect to your LimeSurvey instance
client =  Client(
    "https://mylimesite.limequery.com/admin/remotecontrol",
    "myusername",
    "mypassword",
)

# Print the LimeSurvey version
print(client.get_server_version())

# Print every survey's title
for survey in client.list_surveys():
    print(survey["surveyls_title"])

Integration tests#

Integration tests are run against a LimeSurvey instance, and both PostgreSQL and MySQL backends, using Docker Compose. The following versions of LimeSurvey were tested for this release:

But also, the latest 5.x and 6.x are tested continuously and are expected to work.

How-to guides#