Skip to content

angus-lherrou/PyCap

This branch is 2 commits ahead of, 7 commits behind redcap-tools/PyCap:master.

Folders and files

NameName
Last commit message
Last commit date
Dec 20, 2022
Aug 3, 2022
Apr 18, 2023
Mar 28, 2023
Mar 29, 2022
Jan 3, 2022
Feb 21, 2023
Feb 9, 2022
Nov 17, 2022
Feb 24, 2014
Jan 4, 2023
Dec 27, 2021
Apr 4, 2022
Mar 28, 2023
Mar 28, 2023
Mar 28, 2023
Mar 28, 2023

Repository files navigation

PyCap

CI Codecov PyPI version black

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

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

Import

  • Data Access Groups
  • File
  • Metadata
  • Records
  • Repeating instruments and events
  • Users
  • User-DAG assignment
  • User Roles
  • User-Role assignment

Delete

  • Data Access Groups
  • 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

Packages

No packages published

Languages

  • Python 100.0%