Skip to main content

PyCap: Python interface to REDCap

Project description

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

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycap-2.6.0.tar.gz (24.9 kB view hashes)

Uploaded Source

Built Distribution

pycap-2.6.0-py3-none-any.whl (39.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page