跳转到主要内容

LimeSurvey远程控制API 2的客户端,用现代Python编写。

项目描述

Citric

项目健康 pre-commit.ci status Documentation Status codecov
打包 PyPI version Python versions PyPI - Downloads Conda Version
杂项 Ruff Nox Hatch project License DOI
OpenSSF Scorecard

LimeSurvey远程控制API 2的客户端,用现代Python编写。

功能

  • 通过Session支持完整的RPC API。
  • Client中尽力实现所有RPC方法。有关详细信息,请参阅API覆盖率页面
  • 轻松将调查数据导出为CSV文件、Pandas数据帧DuckDB数据库
  • 轻松下载调查文件(例如图像、音频等)到本地目录。
  • 已针对LimeSurvey 6.0.0+和5.0.0+版本进行测试。
  • 对新REST API提供实验性支持。

安装

# PyPI
pip install citric
# or conda
conda install -c conda-forge 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"])

文档

代码示例和API文档可在citric.readthedocs.io找到。

贡献

如果您想为此项目做出贡献,请参阅贡献指南

致谢

项目详情


下载文件

下载适合您平台的文件。如果您不确定该选择哪个,请了解更多关于安装包的信息。

源分布

citric-1.0.1.tar.gz (186.5 kB 查看哈希值)

上传

构建分布

citric-1.0.1-py3-none-any.whl (26.0 kB 查看哈希值)

上传 Python 3

由以下组织支持