Citric#
Release v0.9.0.
A client to the LimeSurvey Remote Control API 2, written in modern Python.
Release v0.9.0.
A client to the LimeSurvey Remote Control API 2, written in modern Python.
Supports the full RPC API via the Session
class.
Best effort to implement all the RPC methods in the Client
class. See the API coverage page for details.
Easily export survey data to CSV files, Pandas DataFrames and DuckDB databases.
Easily download survey files (e.g. images, audio, etc.) to a local directory.
Tested against LimeSurvey 6.0.0+ and 5.0.0+ versions.
PostgreSQL |
MySQL |
|
---|---|---|
6.2.9 |
✅ |
✅ |
6.2.8 |
✅ |
✅ |
6.2.7 |
✅ |
✅ |
5.6.39 |
✅ |
✅ |
5.6.38 |
✅ |
✅ |
5.6.37 |
✅ |
✅ |
$ pip install citric
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"])
Code samples and API documentation are available at citric.readthedocs.io.
If you’d like to contribute to this project, please see the contributing guide.