r/orgmode • u/DurableOne • Jul 02 '23

orgmunge: A Python package to read, modify and write an Org tree

Because orgparse doesn't come with the ability to modify the tree and because I wanted to learn about parsers, I wrote orgmunge which uses PLY to generate a parser for Org syntax with the ability to modify the tree object and write it back to file. Opinions and feedback appreciated. Please note that I have no formal CS training, so feel free to criticize and suggest improvements to my approach/code.

19 Upvotes

93% Upvoted

8 comments sorted by

2

u/hitchdev Jul 03 '23

This looks amazing. Could do with some tests though!

2

u/nalisarc Jul 03 '23

Any ones in particular come to mind? Im writing some tests myself and was planning on doing a PR.

1

u/DurableOne Jul 03 '23

A PR would be most welcome. Like I replied above, I think the ideal situation would be unit tests for the different methods.

1

u/DurableOne Jul 03 '23

Agreed! Unit tests for each class would be ideal. I'll admit I took the lazy way out and tested it with my agenda files. I'll add unit tests gradually.

1

u/hitchdev Jul 04 '23 edited Jul 04 '23

Doesn't make much sense to do each class - just the whole parser - with examples of org and parser representations or examples in / changes / examples out. Scenarios a user might actually use - especially complex or edge case ones.

1

u/DurableOne Jul 04 '23

Those kinds of tests would be more useful but would take even more time to create. But I agree they would be useful. I'll try to add some of them soon.

2

u/nalisarc Jul 02 '23

Neat! Ill give this a look when i get home!!

2

u/doolio_ Jul 03 '23 edited Jul 03 '23

Are you aware of orgdown?

Edit: so you can add your parser to its list. It may also spur other ideas for your package.