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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file citric-2.3.0.tar.gz.
File metadata
- Download URL: citric-2.3.0.tar.gz
- Upload date:
- Size: 207.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
919b888faa733cea650aed1d69310acf492c31a568e862e7c34ea27c4b262649
|
|
| MD5 |
8311fb2b4dc66ee97e862153ea427f94
|
|
| BLAKE2b-256 |
deb3e2d81ec80e22da9d2dcbade2eb55e877fe9e1b8512f1501dd44c3d708d55
|
Provenance
The following attestation bundles were made for citric-2.3.0.tar.gz:
Publisher:
build.yml on edgarrmondragon/citric
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
citric-2.3.0.tar.gz -
Subject digest:
919b888faa733cea650aed1d69310acf492c31a568e862e7c34ea27c4b262649 - Sigstore transparency entry: 2261574787
- Sigstore integration time:
-
Permalink:
edgarrmondragon/citric@5b05dadc2a1e3e1e5f71ac35e77869f96338dcdc -
Branch / Tag:
refs/tags/2.3.0 - Owner: https://github.com/edgarrmondragon
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build.yml@5b05dadc2a1e3e1e5f71ac35e77869f96338dcdc -
Trigger Event:
push
-
Statement type:
File details
Details for the file citric-2.3.0-py3-none-any.whl.
File metadata
- Download URL: citric-2.3.0-py3-none-any.whl
- Upload date:
- Size: 31.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
680055f31536f8cdc8fa9ec251487de4082efe38f2e70ebd9743626d354c3144
|
|
| MD5 |
fc351270730bfab5c4a0f2ca2172356e
|
|
| BLAKE2b-256 |
f9be636068e020a66a21fae6044241db905aab332eb8d6a1cb0b453cf13de1be
|
Provenance
The following attestation bundles were made for citric-2.3.0-py3-none-any.whl:
Publisher:
build.yml on edgarrmondragon/citric
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
citric-2.3.0-py3-none-any.whl -
Subject digest:
680055f31536f8cdc8fa9ec251487de4082efe38f2e70ebd9743626d354c3144 - Sigstore transparency entry: 2261574895
- Sigstore integration time:
-
Permalink:
edgarrmondragon/citric@5b05dadc2a1e3e1e5f71ac35e77869f96338dcdc -
Branch / Tag:
refs/tags/2.3.0 - Owner: https://github.com/edgarrmondragon
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build.yml@5b05dadc2a1e3e1e5f71ac35e77869f96338dcdc -
Trigger Event:
push
-
Statement type:
