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

Enhance usability #506

Merged
merged 46 commits into from
Jun 3, 2022
Merged

Enhance usability #506

merged 46 commits into from
Jun 3, 2022

Conversation

munrojm
Copy link
Member

@munrojm munrojm commented Feb 4, 2022

This PR aims at enhancing usability of the API though:

  • Generic search method privatized. Rester search methods all renamed to search.
  • query method of MPRester removed and replaced with search in SummaryRester
  • Input parameters for summary search are sorted alphabetically
  • Standardize units in doc models
  • Add information linking summary search parameters to their location in other endpoints
  • Representation changes in doc models to handle data that is not requested -- POSTPONED
  • Allow ALL single entry query params to take in lists of values
  • Strip _id from returned data if no doc model used
  • Give deprecated warning with old search methods

@codecov-commenter
Copy link

codecov-commenter commented Feb 7, 2022

Codecov Report

Merging #506 (f7d9a8d) into main (865f33f) will decrease coverage by 0.56%.
The diff coverage is 87.95%.

@@            Coverage Diff             @@
##             main     #506      +/-   ##
==========================================
- Coverage   92.24%   91.68%   -0.57%     
==========================================
  Files          35       35              
  Lines        1393     1479      +86     
==========================================
+ Hits         1285     1356      +71     
- Misses        108      123      +15     
Impacted Files Coverage Δ
src/mp_api/routes/doi.py 100.00% <ø> (ø)
src/mp_api/routes/phonon.py 100.00% <ø> (ø)
src/mp_api/routes/similarity.py 100.00% <ø> (ø)
src/mp_api/core/client.py 88.01% <36.84%> (-3.15%) ⬇️
src/mp_api/routes/fermi.py 88.88% <66.66%> (-11.12%) ⬇️
src/mp_api/routes/electronic_structure.py 89.70% <82.14%> (+0.39%) ⬆️
src/mp_api/client.py 91.51% <94.11%> (-0.10%) ⬇️
src/mp_api/routes/oxidation_states.py 95.83% <94.44%> (-4.17%) ⬇️
src/mp_api/routes/bonds.py 96.00% <100.00%> (+0.16%) ⬆️
src/mp_api/routes/charge_density.py 86.56% <100.00%> (ø)
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 865f33f...f7d9a8d. Read the comment docs.

@munrojm munrojm added the release:minor Minor release bump label Jun 1, 2022
@munrojm munrojm merged commit 250f51c into main Jun 3, 2022
@munrojm munrojm deleted the enhance_usability branch August 11, 2022 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment