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 content to README; documentation fixups #969

Merged
merged 7 commits into from
Jun 21, 2024

Conversation

rkingsbury
Copy link
Collaborator

@rkingsbury rkingsbury commented Jun 20, 2024

Summary

Makes README more descriptive of `maggma''s purpose and function. Closes #886

See a preview of the README on my fork here:
https://github.com/rkingsbury/maggma/tree/readme

@rkingsbury
Copy link
Collaborator Author

@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)

Copy link

codecov bot commented Jun 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.77%. Comparing base (84f864e) to head (6d58e39).
Report is 11 commits behind head on main.

Current head 6d58e39 differs from pull request most recent head 84d0749

Please upload reports for the commit 84d0749 to get more accurate results.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #969   +/-   ##
=======================================
  Coverage   88.76%   88.77%           
=======================================
  Files          46       46           
  Lines        3979     3981    +2     
=======================================
+ Hits         3532     3534    +2     
  Misses        447      447           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Andrew-S-Rosen
Copy link
Member

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)

@Andrew-S-Rosen
Copy link
Member

Looks good to me!

@Andrew-S-Rosen
Copy link
Member

That example is hilarious!

@rkingsbury rkingsbury self-assigned this Jun 20, 2024
@rkingsbury
Copy link
Collaborator Author

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.

@rkingsbury rkingsbury added the docs documentation label Jun 21, 2024
@rkingsbury rkingsbury merged commit 50bc96f into materialsproject:main Jun 21, 2024
4 of 7 checks passed
@rkingsbury
Copy link
Collaborator Author

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.

@rkingsbury rkingsbury deleted the readme branch June 21, 2024 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README/docs to better reflect the purpose of Maggma
2 participants