Metadata-Version: 2.1
Name: redcapy
Version: 0.4.1
Summary: Python package to access REDCAP API
Home-page: https://github.com/unaisaralegui/redcapy
Author: Unai Saralegui
Author-email: usaralegui@gmail.com
License: UNKNOWN
Description: # redcapy
        
        Library for accessing RedCap API from Python
        
        ## Installation
        
        Install the package with pip directly with:
        
        ```console
        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:
        ```python
        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)
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
