{"id":19713355,"url":"https://github.com/ctsit/redcap_cli","last_synced_at":"2025-08-25T00:32:06.946Z","repository":{"id":57460600,"uuid":"42111423","full_name":"ctsit/redcap_cli","owner":"ctsit","description":"A suite of command line utilities for REDCap with a focus on API interaction.","archived":false,"fork":false,"pushed_at":"2016-04-06T18:57:08.000Z","size":10,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-12-12T07:14:03.289Z","etag":null,"topics":["deprecated","pycap1","python2","redcap","reviewphilp"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ctsit.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-08T12:41:32.000Z","updated_at":"2023-07-11T22:49:04.000Z","dependencies_parsed_at":"2022-09-01T20:24:59.070Z","dependency_job_id":null,"html_url":"https://github.com/ctsit/redcap_cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctsit%2Fredcap_cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctsit%2Fredcap_cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctsit%2Fredcap_cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctsit%2Fredcap_cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ctsit","download_url":"https://codeload.github.com/ctsit/redcap_cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230852607,"owners_count":18290081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deprecated","pycap1","python2","redcap","reviewphilp"],"created_at":"2024-11-11T22:21:12.788Z","updated_at":"2024-12-22T15:55:35.671Z","avatar_url":"https://github.com/ctsit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"redcap\\_cli\n===========\n\nREDCap Command Line Interface\n-----------------------------\n\nREDCap CLI is a suite of tools for interacting with Vanderbilt\nUniversity's Research Electronic Data Capture, tool know as REDCap.\nThese tools provide a command line interface for interacting with a\nREDCap server's application programming interface (API). REDCAp CLI is\nwritten in Pythin and uses the PyCap library for all interaction with\nthe API.\n\nInstallation\n------------\n\nTo install from source, use setup.py\n\n::\n\n    python setup.py install\n\nTo install from the Python Package Index, use your favorite python\npackage installer:\n\n::\n\n    pip install redcap_cli\n\nor\n\n::\n\n    easy_install redcap_cli\n\nPackage Contents\n----------------\n\nREDCap CLI currently installs two utilities:\n\n-  redcap\\_records - imports and exports data from a REDCap project.\n-  redcap\\_metadata - exports project metadata from a REDCap project.\n\nUsage Instructions\n------------------\n\nThe redcap\\_cli utilities have a rich list of command line options.\nThese options reflect the features and terminology of the REDCap API. To\nsee the options supported by each tool. Run the tool with the \"-h\"\noption.\n\n::\n\n    # redcap_records.py -h\n    usage: redcap_records.py [-h] --token TOKEN --url URL\n                             [--verify_ssl VERIFY_SSL] [-i IMPORT_DATA] [-f FORMS]\n                             [-t {json,csv,xml}] [--fields FIELDS] [-e EVENTS]\n                             [-r RECORDS]\n\n    Read some data from a REDCap Project\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      --token TOKEN         Specify the authentication/authorization token that\n                            will provide access to the REDCap project\n      --url URL             Specify the url of the REDCap server to connect with\n      --verify_ssl VERIFY_SSL\n                            Specify whether the SSL cert of the REDCap server\n                            should be checked\n      -i IMPORT_DATA, --import_data IMPORT_DATA\n                            Specify the input data file to load into REDCap\n      -f FORMS, --forms FORMS\n                            Specify a list of forms, separated by spaces, for\n                            which data should be returned.\n      -t {json,csv,xml}, --type {json,csv,xml}\n                            Specify the file type used as input or output. Valid\n                            types: json, csv, xml\n      --fields FIELDS       Specify a list of fields, separated by spaces, for\n                            which data should be returned.\n      -e EVENTS, --events EVENTS\n                            Specify a list of events, separated by spaces, for\n                            which data should be returned.\n      -r RECORDS, --records RECORDS\n                            Specify a list of records, separated by spaces, for\n                            which data should be returned.\n      -d, --debug           Print even more detailed output\n      -v, --verbose         Print detailed output\n\nInput data\n----------\n\nREDCap CLI tools consume data in the exact formats it generates for\noutput. To generate an example input file, for a project, populate the\nproject with the project with sample data and export it with\nredcap\\_records. The same data can be reimported when using the same\ncommand line options.\n\nOutput data\n-----------\n\nData output by REDCap records is kept as close as possible to the native\nREDCap output. The output data is only modified to enhance readability\non the command line or improve re-import.\n\nRequirements\n------------\n\nThis project requires Python 2.7 or greater and PyCap 1.0 or greater.\n\nContributions\n-------------\n\nThe redcap\\_CLI Team welcomes contributions to this project. Please fork\nand send pull requests with your revisions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctsit%2Fredcap_cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fctsit%2Fredcap_cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctsit%2Fredcap_cli/lists"}