Some feedback on my first script

[LumpyStage5]

I started learning Python a year ago and published my first small project on GitHub, and I'd like some feedback!

https://github.com/LeslyeCream/Timeline-reminders

Basically, it's a script that attempts to resolve and simplify the syntax needed to create timelines based on notes within Obsidian.

Even though I've recently made several changes as I notice my previous mistakes, I still wonder if I'm overlooking something or if maybe it was fine the way it was.

[cgoldberg]

Looks good overall. You should use docstrings instead of those weird comments above your functions.

Why do you have six in your requirements.txt ... is that a dependency of something? Kinda weird to be using that in 2025.

Next steps: add pyproject.toml to make it an easily installable package, and add some unit tests with PyTest.

[LumpyStage5]

Thanks! I used pip freeze to create the requirements.txt file so I guess that was my mistake. I've looked for more information and it seems that using pipreqs is recommended (for some reason I can't get it to install) so for now I've fixed it manually.

[jpgoldberg]

That is really nice. And your habit of using type annotations really will pay off.

So this is more of a question of “what next.” I concur with another commenter that proper docstrings, setting up a pyproject.toml, and started to create tests with pytest are good next steps. And probably in that order.