Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Arm and Event API #278

Merged
merged 15 commits into from
Oct 31, 2023
Merged

Add Arm and Event API #278

merged 15 commits into from
Oct 31, 2023

Conversation

patking02
Copy link
Contributor

Fixes #276 and #277

Adds Arm and Event API methods, tests, and documentation.

I initially was going to separate these two out (one PR for Arm, one for Event), but while writing the tests for Arm, I realized I needed to attach an Event to the Arm in order for the Arm Export to return the newly added arm. If need be, I can do one at a time (I guess Event then Arm), but if it is OK to submit/review both at the same time, then here they are.

I tested the Unit tests, but I did not have access to run the Integration Tests, FYI.

@pwildenhain
Copy link
Collaborator

Amazing thank you! I'll take a look at some point this weekend or early next week

@codecov
Copy link

codecov bot commented Oct 30, 2023

Codecov Report

Merging #278 (46bbf78) into master (a168006) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #278   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        21    +2     
  Lines          571       625   +54     
=========================================
+ Hits           571       625   +54     
Files Coverage Δ
redcap/methods/__init__.py 100.00% <100.00%> (ø)
redcap/methods/arms.py 100.00% <100.00%> (ø)
redcap/methods/base.py 100.00% <ø> (ø)
redcap/methods/events.py 100.00% <100.00%> (ø)
redcap/methods/user_roles.py 100.00% <ø> (ø)
redcap/methods/users.py 100.00% <ø> (ø)
redcap/project.py 100.00% <ø> (ø)

Copy link
Collaborator

@pwildenhain pwildenhain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is truly incredible. Without a doubt, the cleanest PR I've ever received, and especially impressive for a first time contributor. Not only do the code changes mesh perfectly with the rest of the codebase but you also updated docs (and doctests), unit tests, and integration tests which are each a world of their own.

I'm super impressed 🤩 If you're ever looking for a job, let me know, you seem like a grade-A coder.

I've made a few updates to the integration/doctests (which was to be expected since you don't have permissions run them) that you can review here: patking02#1

Once these are merged, I'll merge this PR and cut a new release pronto ⚡

@pwildenhain pwildenhain linked an issue Oct 30, 2023 that may be closed by this pull request
@patking02
Copy link
Contributor Author

Thanks for the kind words; the PyCap library is well maintained and has a lot of good checks and standards in place that made my job easy.

Happy to help contribute and give back to the community. Thank you for reviewing the PR.

@pwildenhain pwildenhain self-requested a review October 31, 2023 18:26
Copy link
Collaborator

@pwildenhain pwildenhain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯 👏🏻

@pwildenhain pwildenhain merged commit 6b0d453 into redcap-tools:master Oct 31, 2023
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Event API Add Arm API
2 participants