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
  • Instruments
  • Instrument-event mapping
  • File
  • File Repository
  • Logging
  • Metadata
  • Project Info
  • PDF of instruments
  • Records
  • Repeating instruments and events
  • Report
  • Surveys
  • Users
  • User-DAG assignment
  • User Roles
  • User-Role assignment
  • Version

Import

  • Arms
  • Data Access Groups
  • Events
  • File
  • File Repository
  • 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
  • File Repository
  • 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.7.0.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

pycap-2.7.0-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

Details for the file pycap-2.7.0.tar.gz.

File metadata

  • Download URL: pycap-2.7.0.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.9.6 Darwin/24.2.0

File hashes

Hashes for pycap-2.7.0.tar.gz
Algorithm Hash digest
SHA256 02f7ad47cc3d729b126d34850039fc942683a8061a348abc5105b344a1823f44
MD5 d050372ef2db70297cd7657b9f0bc7cb
BLAKE2b-256 b211502cb723527da142dcc77cbea771584f7cc0e52f0d0ecfd0be336b1a8d1b

See more details on using hashes here.

File details

Details for the file pycap-2.7.0-py3-none-any.whl.

File metadata

  • Download URL: pycap-2.7.0-py3-none-any.whl
  • Upload date:
  • Size: 42.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.9.6 Darwin/24.2.0

File hashes

Hashes for pycap-2.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7e1342b842b6c2af55e30afc54a7e49d6fa7ba446b3c614ec7d87f90ff3e58d
MD5 b0fa468294c9841eef4b32312f46a401
BLAKE2b-256 61f06aee86a0145b84a99e40a61badea6d62528fc962d7bb2563838b90084c01

See more details on using hashes here.

Supported by

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