# PyCap
[](https://github.com/redcap-tools/PyCap/actions/workflows/ci.yml)
[](https://codecov.io/gh/redcap-tools/PyCap)
[](https://badge.fury.io/py/pycap)
[](https://pypi.org/project/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`](https://pypi.python.org/pypi/pip)
```sh
$ pip install PyCap
```
If you want to load REDCap data into [`pandas`](https://pandas.pydata.org/) dataframes, this will make sure you have `pandas` installed
```sh
$ pip install PyCap[all]
```
To install the bleeding edge version from the github repo, use the following
```sh
$ pip install -e git+https://github.com/redcap-tools/PyCap.git#egg=PyCap
```
## Documentation
Canonical documentation and usage examples can be found [here](https://redcap-tools.github.io/PyCap/).
## Features
Currently, these API calls are available:
### Export
* Arms
* Data Access Groups
* Events
* 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
* Arms
* Data Access Groups
* Events
* File
* Metadata
* Records
* Repeating instruments and events
* Users
* User-DAG assignment
* User Roles
* User-Role assignment
### Delete
* Arms
* Data Access Groups
* Events
* File
* 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
Raw data
{
"_id": null,
"home_page": "https://github.com/redcap-tools/PyCap",
"name": "pycap",
"maintainer": "Paul Wildenhain",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "pwildenhain@gmail.com",
"keywords": "",
"author": "Scott Burns",
"author_email": "scott.s.burns@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/55/53/10802062df533df169892da7f72d926d63af97bd354ae7fdff043db4d842/pycap-2.6.0.tar.gz",
"platform": null,
"description": "# PyCap\n\n[](https://github.com/redcap-tools/PyCap/actions/workflows/ci.yml)\n[](https://codecov.io/gh/redcap-tools/PyCap)\n[](https://badge.fury.io/py/pycap)\n[](https://pypi.org/project/black/)\n\n## Intro\n\n`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/.\n\nAvailable under the MIT license.\n\n## Installation\n\nInstall the latest version with [`pip`](https://pypi.python.org/pypi/pip)\n\n```sh\n$ pip install PyCap\n```\n\nIf you want to load REDCap data into [`pandas`](https://pandas.pydata.org/) dataframes, this will make sure you have `pandas` installed\n\n```sh\n$ pip install PyCap[all]\n```\n\nTo install the bleeding edge version from the github repo, use the following\n\n```sh\n$ pip install -e git+https://github.com/redcap-tools/PyCap.git#egg=PyCap\n```\n\n## Documentation\n\nCanonical documentation and usage examples can be found [here](https://redcap-tools.github.io/PyCap/).\n\n## Features\n\nCurrently, these API calls are available:\n\n### Export\n\n* Arms\n* Data Access Groups\n* Events\n* Field names\n* Instrument-event mapping\n* File\n* Logging\n* Metadata\n* Project Info\n* Records\n* Repeating instruments and events\n* Report\n* Survey participant list\n* Users\n* User-DAG assignment\n* User Roles\n* User-Role assignment\n* Version\n\n### Import\n\n* Arms\n* Data Access Groups\n* Events\n* File\n* Metadata\n* Records\n* Repeating instruments and events\n* Users\n* User-DAG assignment\n* User Roles\n* User-Role assignment\n\n### Delete\n\n* Arms\n* Data Access Groups\n* Events\n* File\n* Records\n* Users\n* User Roles\n\n### Other\n\n* Generate next record name\n* Switch data access group\n\n## Citing\n\nIf you use PyCap in your research, please consider citing the software:\n\n> Burns, S. S., Browne, A., Davis, G. N., Rimrodt, S. L., & Cutting, L. E. PyCap (Version 1.0) [Computer Software].\n> Nashville, TN: Vanderbilt University and Philadelphia, PA: Childrens Hospital of Philadelphia.\n> Available from https://github.com/redcap-tools/PyCap. doi:10.5281/zenodo.9917\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "PyCap: Python interface to REDCap",
"version": "2.6.0",
"project_urls": {
"Documentation": "http://redcap-tools.github.io/PyCap/",
"Homepage": "https://github.com/redcap-tools/PyCap",
"Repository": "https://github.com/redcap-tools/PyCap"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e4c74f11e400a19523901f55da9a6f905d2b5e614621b3c53117107e858e9f18",
"md5": "92cf1c2af2eb7672f1a6a02bad8c631e",
"sha256": "404a7ba299fa57f0fcadd9f4b6df123e593deda1dcb12b341f39b416b6e83d6b"
},
"downloads": -1,
"filename": "pycap-2.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92cf1c2af2eb7672f1a6a02bad8c631e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 39023,
"upload_time": "2023-11-03T19:29:21",
"upload_time_iso_8601": "2023-11-03T19:29:21.863414Z",
"url": "https://files.pythonhosted.org/packages/e4/c7/4f11e400a19523901f55da9a6f905d2b5e614621b3c53117107e858e9f18/pycap-2.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "555310802062df533df169892da7f72d926d63af97bd354ae7fdff043db4d842",
"md5": "884add49e19f37d53e93ce0a5187f3e1",
"sha256": "68d7403bf573b03ae24cb252fb1e5f73fe365b6c9d54c46199014edaffcc8f94"
},
"downloads": -1,
"filename": "pycap-2.6.0.tar.gz",
"has_sig": false,
"md5_digest": "884add49e19f37d53e93ce0a5187f3e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 24912,
"upload_time": "2023-11-03T19:29:23",
"upload_time_iso_8601": "2023-11-03T19:29:23.612533Z",
"url": "https://files.pythonhosted.org/packages/55/53/10802062df533df169892da7f72d926d63af97bd354ae7fdff043db4d842/pycap-2.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 19:29:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "redcap-tools",
"github_project": "PyCap",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pycap"
}
JSON
