I have done plenty of basic scripting for work, but this is my first “real” project, and wanted to see what real python experts think of it and see if there is anything I might be doing horribly wrong lol.
Im deploying documentation automatically here: https://ogs-python.dakotamarshall.net/
And the PyPI package is here: https://pypi.org/project/ogsapi/
I am very much a beginner, and its still very much a work in progress. Let me know if there is anything that could be drastically improved!
Kind of silly since python is basically source code in wheel form, but you have the package on pypi listed as gpl3 but don’t provide a source repo link.
Also, I write worse code than this and get paid a lot for it :P don’t sell yourself short
I would import whatever functions you want users to use often in the init script of the ogsapi module … But idk python packages are all over the place with stuff like that, it’s definitely not required.
After a quick skim, I might suggest looking into dataclasses. Particularly that
OGSGame
class might be a good candidate. They can remove a lot of necessary init boilerplate, and you’d getasdict
for free.Just discovered dataclasses the other day actually, Im using it for
OGSCredentials
and am happy with how easy it was, so I will be converting other stuff over to it as well!I would opt for Traitlets over dataclasses… but both are superior to vanilla Python objects.
oh you stored it on gitlab instead of github… quite unique.