forked from PFWhite/cappy
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
70 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,21 @@ | ||
# Lineman Authors | ||
Authors | ||
|
||
The RED-I Project would not be possible without the generous contributions of | ||
our authors and contributors. Lineman is a tool that contributes to RED-I by | ||
ensuring that all your JSON data will be REDCAP compliant. | ||
Cappy is a tool that contributes to RED-I by ensuring that all your JSON data | ||
will be REDCap compliant. The RED-I Project would not be possible without the | ||
generous contributions of our authors and contributors. | ||
|
||
David R Nelson and his HCV Target project and the University of Florida | ||
Clinical Translational Science Institute for providing the seed funding | ||
that launched the RED-I Project. | ||
David R. Nelson and his HCV Target project and the University of Florida | ||
Clinical Translational Science Institute provded the seed funding that launched | ||
the RED-I Project. | ||
|
||
Patrick F. White (pfwhite9@gmail.com) Inventor | ||
Christopher P. Barnes (senrabc@gmail.com) | ||
Matthew J. McConnell (devmattm@gmail.com) | ||
Michael J. Buchholz (ufbuck72@gmail.com) | ||
Patrick F. White (pfwhite9@gmail.com) Inventor | ||
Christopher P. Barnes (senrabc@gmail.com) | ||
Naomi Bruan (looseymoose@ufl.edu) | ||
Michael J. Buchholz (ufbuck72@gmail.com) | ||
Matthew J. McConnell (devmattm@gmail.com) | ||
Taeber Rapczak (taeber@ufl.edu) | ||
|
||
|
||
Many thanks to David Nelson, Mike Freid, Joy Peter, Ken Berguist, and | ||
Monika Vainorius of the HCV Target Study Team and all of the HCV Target study | ||
Monika Vainorius of the HCV-Target Study Team and all of the HCV-Target study | ||
sites for being the pilot project for RED-I. You all helped make it great. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,27 @@ | ||
# CHANGELOG | ||
Change Log | ||
|
||
## [1.2.1] 2018-08-30 | ||
### Fixed | ||
* Corrected the version number throughout the documentation and code. | ||
[2.0.0] 2019-11-07 | ||
|
||
Converted to Python 3. | ||
|
||
## [1.2.0] 2017-10-24 | ||
### Summary | ||
* This update adds better version control mechanisms to the project. | ||
* Update iterating for python3 (Naomi Braun) | ||
* Update docs and bump to version 2.0.0 (Taeber Rapczak) | ||
|
||
|
||
[1.2.1] 2018-08-30 | ||
|
||
Corrected the version number throughout the documentation and code. | ||
|
||
|
||
[1.2.0] 2017-10-24 | ||
|
||
Added better version control mechanisms to the project. | ||
|
||
### Added | ||
* Add the versions to requirements (Matthew McConnell) | ||
* update license to APACHE2 (Matthew McConnell) | ||
|
||
|
||
## [1.0.0] 2017-04-26 | ||
### Summary | ||
* This is the initial release of cappy, a python module for interfacing with | ||
the Redcap API | ||
[1.0.0] 2017-04-26 | ||
|
||
Initial release of cappy, a python module for interfacing with the Redcap API. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,30 @@ | ||
# cappy v1.2.1 | ||
The Redcap API library that you build yourself. | ||
Cappy | ||
===== | ||
|
||
## Ideology ## | ||
The REDCap API library that you build yourself. | ||
|
||
A module should do one thing and do it well. Cappy calls the redcap API. It does not rate limit, it does not | ||
tell you how to organize the data you get back, it does not handle errors nor declare any new exception types. | ||
Ideology | ||
-------- | ||
|
||
## Usage ## | ||
A module should do one thing and do it well. Cappy calls the REDCap API. It | ||
does not rate limit, it does not tell you how to organize the data you get | ||
back, it does not handle errors nor declare any new exception types. | ||
|
||
The redcap API requires a token, and an endpoint. Also Cappy uses a version file that specifies the API | ||
calls you want to support. You pass all three of these into the API constructor to get an instance of the | ||
api. This instance has methods corresponding to the definitions in the json file. | ||
|
||
Any API call that pushes data takes the data object as the first parameter. This would be calls like `import_record` | ||
and the like. Any iterable thing other than data is passed by a keyword param. More information can be found in the | ||
doc strings of cap.py | ||
Usage | ||
----- | ||
|
||
Happy redcapping! | ||
The REDCap API requires a token and an endpoint. Also, Cappy uses a version file | ||
that specifies the API calls you want to support. You pass all three of these | ||
into the API constructor to get an instance of the API. This instance has | ||
methods corresponding to the definitions in the JSON file. | ||
|
||
Any API call that pushes data takes the data object as the first parameter. | ||
This would be calls like `import_record` and the like. Any [iterable][] thing | ||
other than data is passed by a keyword parameter. More information can be found | ||
in the docstring of `cap.py`. | ||
|
||
Happy REDCapping! | ||
|
||
[iterable]: https://docs.python.org/3/glossary.html#term-iterable | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
#This file contains only the current version number | ||
|
||
__version__ = "1.2.1" | ||
__version__ = "2.0.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,6 @@ | ||
appdirs==1.4.3 | ||
certifi==2017.4.17 | ||
certifi==2019.9.11 | ||
chardet==3.0.4 | ||
idna==2.5 | ||
packaging==16.8 | ||
pyparsing==2.2.0 | ||
PyYAML==3.12 | ||
requests==2.18.1 | ||
six==1.10.0 | ||
urllib3==1.21.1 | ||
idna==2.8 | ||
PyYAML==5.1.2 | ||
requests==2.22.0 | ||
urllib3==1.25.6 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters