limette

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


Keywords
limette, limesurvey, python, survey
License
MIT
Install
pip install limette==1.0.2

Documentation

Citric

Project Health pre-commit.ci status Documentation Status codecov
Packaging PyPI version Python versions PyPI - Downloads Conda Version
Misc Ruff Nox Hatch project License DOI
OpenSSF Scorecard

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

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"])

Documentation

Code samples and API documentation are available at citric.readthedocs.io.

Contributing

If you'd like to contribute to this project, please see the contributing guide.

Credits