PyCap

Intro

PyCap is a python module exposing the REDCap API through some helpful abstractions. Information about the REDCap project can be found at https://project-redcap.org/.

Available under the MIT license.

Installation

Install the latest version with pip

$ pip install PyCap

If you want to load REDCap data into pandas dataframes, this will make sure you have pandas installed

$ pip install PyCap[all]

To install the bleeding edge version from the github repo, use the following

$ pip install -e git+https://github.com/redcap-tools/PyCap.git#egg=PyCap

Documentation

Canonical documentation and usage examples can be found here.

Features

Currently, these API calls are available:

Export

Arms
Data Access Groups
Events
Field names
Instruments
Instrument-event mapping
File
Logging
Metadata
Project Info
PDF of instruments
Records
Repeating instruments and events
Report
Survey participant list
Users
User-DAG assignment
User Roles
User-Role assignment
Version

Import

Arms
Data Access Groups
Events
File
Instrument-event mapping
Metadata
Records
Repeating instruments and events
Users
User-DAG assignment
User Roles
User-Role assignment

Delete

Arms
Data Access Groups
Events
File
Records
Users
User Roles

Other

Generate next record name
Switch data access group

Citing

If you use PyCap in your research, please consider citing the software:

Burns, S. S., Browne, A., Davis, G. N., Rimrodt, S. L., & Cutting, L. E. PyCap (Version 1.0) [Computer Software]. Nashville, TN: Vanderbilt University and Philadelphia, PA: Childrens Hospital of Philadelphia. Available from https://github.com/redcap-tools/PyCap. doi:10.5281/zenodo.9917