A client to the LimeSurvey Remote Control API 2, written in modern Python.
Project description
Features
- 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+ LTS versions.
Installation
$ pip install citric
Usage
from citric import Client
with Client(
"https://mylimesite.limequery.com/admin/remotecontrol",
"myusername",
"mypassword",
) as client:
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
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
citric-0.7.2.tar.gz
(21.4 kB
view hashes)
Built Distribution
citric-0.7.2-py3-none-any.whl
(21.5 kB
view hashes)