Closed rkingsbury closed 4 months ago
@Andrew-S-Rosen any suggested revision are welcome!
@munrojm does it make sense to add a paragraph about what the API piece of maggma
does? If so, could you post some text here and I can integrate it?
Looking at the docs, I realize that there is currently nothing in there about the API components at all; that's probably something we should add at some point (separate issue though)
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 88.77%. Comparing base (
84f864e
) to head (6d58e39
). Report is 11 commits behind head on main.:exclamation: Current head 6d58e39 differs from pull request most recent head 84d0749
Please upload reports for the commit 84d0749 to get more accurate results.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Looks great! Did we want to add a minimal example so people visually know what we are talking about? Something like
my_data = {"a": 1, "b": 2}
store = MongoStore( database="my_db_name", collection_name="my_collection_name", username="my_username", password="my_password", host="my_hostname", port=27017, )
with store:
store.update(my_data)
Looks good to me!
That example is hilarious!
Now that I realize we don't have any documentation of the API components, I'm going to remove the placeholder from the README and merge this. I've opened #972 as a placeholder to remind us that this documentation should be added at some point.
There is an open_data test failure that snuck in on the last dependency upgrade, which I can't reproduce locally. I'm merging this b/c it's unrelated and will see if re-triggering the auto dependency upgrade can resolve.
Summary
Makes
README
more descriptive of `maggma''s purpose and function. Closes #886See a preview of the README on my fork here: https://github.com/rkingsbury/maggma/tree/readme