Read mdocfile data from a string #28
Conversation
|
Awesome PR, thanks so much for taking the time! I love the class method but not so much the top level API of read_string. Could you remove it? This would give you Mdoc.from_string().as_dataframe() in your own scripts/applications which doesn't feel too onerous, what do you think? 🙂 |
|
Whoops, sorry I thought the API already had Mdoc.as_dataframe(), could you move your _read helper into that method on the Mdoc class? |
|
Sounds good, I'll go ahead and remove the added documentation as well. And maybe mention this new method in the documentation (or not)? |
|
Documenting this is a good idea!👍 |
|
Done, let me know if I should change / improve anything! |
|
Particularly the usage, is this okay? from mdocfile.data_models import Mdoc
mdoc_data = ...
mdoc = Mdoc.from_string(mdoc_data).as_dataframe() |
|
Looks great! In an extra section "parsing from text" |
|
Sounds good! I've updated the README and index.md files, let me know if I should only be changing one or if I should be adding a new page or something like that. Thanks! |
|
Hi, @alisterburt, could this get merged in? And was wondering if this could be included in a release anytime soon? Thanks! |
There was a problem hiding this comment.
Looks great! Thank you for the PR @daniel-ji 🙂 really great work!
|
@daniel-ji I can push a release but it won't be for a few days at least - I'm currently on vacation 🙂 Maybe @brisvag or @jojoelfe can push a release here? Unsure who has permissions (Would do it but I'm on mobile) |
|
I would, but doesn't look like I can... |
|
No worries, it can wait awhile, sorry for all the bothering. I hope you enjoy your vacation! |
|
I pushed a tag, but we have no CI publish workflow it seems. I cannot do it manually cause I'm not maintainer on pypi, nor member of the teamtomo org there... I think we need to set up trusted publishing and all that :P |
|
But... there is a CI publish workflow? ci.yml - i don't see the tag pushed |
|
Bizarre... There was some weirdness with git, I could see the tag on the remote and it said "all up to date" so I assume the tag was pushed. For some reason I had to explicitly use |
|
Thanks for getting back to it so fast @brisvag ! Congratulations @daniel-ji on your first PR to the project and to teamtomo, your changes have been released in v0.1.3 https://github.com/teamtomo/mdocfile/actions/runs/10419687859 |
|
Awesome, thank you guys all so much for the quick and fantastic work! |
Resolves #27. Can now call
read_string(mdoc_file_data)in addition toread(mdoc_file)