Skip to main content

Python package to access REDCAP API

Project description

redcapy

Library for accessing RedCap API from Python

Installation

Install the package with pip directly with:

pip install redcapy

Implemented functionalities

Get data from API

By now the implemented functionalities are for obtaining data from the REDCAP server, no API calls related with saving new data data or deleting data has been implemented. Available API calls are:

import redcapy
import datetime
redcap_handler = redcapy.request.APIHandler(api_url=api_url, token=token)
metadata = redcap_handler.get_metadata()
redcap_version = redcap_handler.get_redcap_version()
users = redcap_handler.get_users()
arms = redcap_handler.get_arms()
events = redcap_handler.get_events()
field_names = redcap_handler.get_field_names()
file = redcap_handler.get_file(record=1)
form_event_mapping = redcap_handler.get_form_event_mapping()
instruments_pdf = redcap_handler.get_instruments_pdf(output_file="./instruments.pdf")
instruments = redcap_handler.get_instruments()
project = redcap_handler.get_project_info()
report = redcap_handler.get_reports(1)
participant_list = redcap_handler.get_participant_list(instrument=instruments[-1]['instrument_name'])
records = redcap_handler.get_records()
date_range_begin = datetime.datetime.strptime("2019-10-10", "%Y-%m-%d")
date_range_end = datetime.datetime.strptime("2019-12-10", "%Y-%m-%d")
records = redcap_handler.get_records(date_range_begin=date_range_begin, date_range_end=date_range_end)

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

redcapy-0.4.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

redcapy-0.4.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file redcapy-0.4.1.tar.gz.

File metadata

  • Download URL: redcapy-0.4.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for redcapy-0.4.1.tar.gz
Algorithm Hash digest
SHA256 ab5415fbf79e3d1b864b04d36ee8ebbd62455ee9f77715c385c5f5d66f9eb60b
MD5 b50a9f9f1d2bb2ea5caaf953ef31d0df
BLAKE2b-256 6cb040c4b6aedceaa7e764ade0489ff47c40910c3cf3c0ea2f402048f8a82651

See more details on using hashes here.

File details

Details for the file redcapy-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: redcapy-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for redcapy-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d3bd28b414074542d0bef86ae68386bdf48dd785e32485d8c88ac097e6ab0d6
MD5 6fc13945db06e3390645422fdf0a5701
BLAKE2b-256 0258de9c625ff1e51d84613ef809754fe3cd57bda210f9cbbb021dafc88b90a5

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