Our great sponsors
-
Waypoint
A command-line tool will process input .txt files into generated .html files. (by rabroldan)
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
Hi everyone, I recently had the chance to integrate a CI workflow into TXT to HTML Converter project. I'll talk about it below.
I made a contribution to my peer's program called Waypoint. I made a contribution to their testers. The way they had it setup was different from mine. I had my program store all the testers in a tests folder for organizational reasons. I also split up the testers for each file, for example my testers for my helpers.py would have its own tester file. While my peer combined all their testers into one file. However, we both used unittest so I could just look at their code and jump right into creating a unittest. Thanks to my prior knowledge of making unittests for my program, this was simple. I created a tester to test the output of the function that handles Markdown conversion. I tested it, then committed and then made a PR. The tester worked with the CI my peer made and so they merged it. This leads me to my final thoughts about CI.
Thankfully, my project has no dependencies so I don't have to make pip install anything other than Ruff to lint my code, which you can see above. I only make my program run the testers with two versions of Python, 3.11 and 3.12. I chose these versions in particular because there is a library my program uses called tomllib. Tomllib is built into Python 3.11 and above, which means that my program does not support 3.10 and below. So I've only made it test with the two most recent versions of Python. I also wanted to attempt running my program on different OSs, like Ubuntu and MacOS, but I believe way those two OSs handle file paths differently from Windows. So when I was trying to handle file paths, it was expecting it in the Windows way and not the Linux way. So for now, it looks like my program does not work with Linux and MacOS. That concludes what I did for my workflow, next I'll talk about writing a test for a peer's program.