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 http://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[pandas]

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

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.1.0.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

PyCap-2.1.0-py3-none-any.whl (34.2 kB view details)

Uploaded Python 3

File details

Details for the file PyCap-2.1.0.tar.gz.

File metadata

  • Download URL: PyCap-2.1.0.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.6 Darwin/20.6.0

File hashes

Hashes for PyCap-2.1.0.tar.gz
Algorithm Hash digest
SHA256 9e5091baca4962a2bb054696514fa8436fe2ac0cb18b1b9e8aa3ed5a14be6e3a
MD5 9ae66d863f7a9f0d3853092d2c664c28
BLAKE2b-256 9ed979f09e5faf4dd8a89447b882c4bb221b8b75c415be4b4ca3d0ae41adec6f

See more details on using hashes here.

File details

Details for the file PyCap-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: PyCap-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 34.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.6 Darwin/20.6.0

File hashes

Hashes for PyCap-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11cb4e39b3829abe0e124c5d6ab9a374430e22cf2a80392a3f664ae322d08854
MD5 e0f6ccd7003a265991268630d1d5794a
BLAKE2b-256 cb947d4deb1073b52a999e606ca4b52425be1cfc340075095f0a66348c022f79

See more details on using hashes here.

Supported by

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