一套用于redcap的命令行实用程序,重点是api交互。
redcap_cli的Python项目详细描述
redcap命令行界面
redcap cli是一套用于与vanderbilt交互的工具 大学研究电子数据采集,工具称为redcap。 这些工具为与 Redcap服务器的应用程序编程接口(API)。redcap cli是 用pythin编写并使用pycap库与 API。
安装
要从源安装,请使用setup.py
python setup.py install
要从python包索引安装,请使用您喜爱的python 软件包安装程序:
pip install redcap_cli
或
easy_install redcap_cli
包装内容
redcap cli当前安装两个实用程序:
- redcap_记录-从redcap项目导入和导出数据。
- redcap_metadata-从redcap项目导出项目元数据。
使用说明
redcap_cli实用程序具有丰富的命令行选项列表。 这些选项反映了redcap api的特性和术语。到 请参见每个工具支持的选项。使用“-h”运行工具 选择。
# redcap_records.py -h usage: redcap_records.py [-h] --token TOKEN --url URL [--verify_ssl VERIFY_SSL] [-i IMPORT_DATA] [-f FORMS] [-t {json,csv,xml}] [--fields FIELDS] [-e EVENTS] [-r RECORDS] Read some data from a REDCap Project optional arguments: -h, --help show this help message and exit --token TOKEN Specify the authentication/authorization token that will provide access to the REDCap project --url URL Specify the url of the REDCap server to connect with --verify_ssl VERIFY_SSL Specify whether the SSL cert of the REDCap server should be checked -i IMPORT_DATA, --import_data IMPORT_DATA Specify the input data file to load into REDCap -f FORMS, --forms FORMS Specify a list of forms, separated by spaces, for which data should be returned. -t {json,csv,xml}, --type {json,csv,xml} Specify the file type used as input or output. Valid types: json, csv, xml --fields FIELDS Specify a list of fields, separated by spaces, for which data should be returned. -e EVENTS, --events EVENTS Specify a list of events, separated by spaces, for which data should be returned. -r RECORDS, --records RECORDS Specify a list of records, separated by spaces, for which data should be returned.
输入数据
redcap cli工具使用它为其生成的精确格式的数据 输出。若要生成示例输入文件,请为项目填充 使用带有示例数据的项目进行项目并将其导出 雷德卡普记录。使用相同的数据时,可以重新导入相同的数据 命令行选项。
输出数据
redcap记录输出的数据尽可能接近本机 redcap输出。输出数据只被修改以增强可读性 在命令行或改进重新导入。
要求
此项目需要Python2.7或更高版本和PyCap1.0或更高版本。
贡献
redcap_cli团队欢迎对该项目的贡献。请用叉子叉 发送请求和修改。