Citric
| Project Health |
|
| Packaging |
|
| Misc |
|
A client to the LimeSurvey Remote Control API 2, written in modern Python.
Features
- Supports the full RPC API via the
Sessionclass. - Best effort to implement all the RPC methods in the
Clientclass. 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 versions 6 and 7.
- Experimental support for the new REST API.
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
- The LimeSurvey team for providing a great survey platform.
- Markus Opolka for maintaining a very robust set of LimeSurvey Docker images.
- Claudio Jolowicz and his amazing blog post.
1 maintainer
Metadata
1 maintainer
Release files for citric 2.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| citric-2.3.0.tar.gz | 207.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| citric-2.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 238.7 kB
Release files / citric-2.3.0.tar.gz
| Download URL | citric-2.3.0.tar.gz |
|---|---|
| Size | 207.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
919b888faa733cea650aed1d69310acf492c31a568e862e7c34ea27c4b262649
|
|
BLAKE2b-256 checksum How to use checksums |
deb3e2d81ec80e22da9d2dcbade2eb55e877fe9e1b8512f1501dd44c3d708d55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 27, 2026.
Transparency logRelease files / citric-2.3.0-py3-none-any.whl
| Download URL | citric-2.3.0-py3-none-any.whl |
|---|---|
| Size | 31.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
680055f31536f8cdc8fa9ec251487de4082efe38f2e70ebd9743626d354c3144
|
|
BLAKE2b-256 checksum How to use checksums |
f9be636068e020a66a21fae6044241db905aab332eb8d6a1cb0b453cf13de1be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 27, 2026.
Transparency log
