Working on my first real python project - an API wrapper for a Go server I play on - Looking for advice / tips! (gitlab.com)

submitted 1 year ago by BoneALisa@lemm.ee to c/python@programming.dev

15 comments fedilink hide all child comments

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!

you are viewing a single comment's thread
view the rest of the comments

[-] mvee@lemmy.ml 3 points 1 year ago* (last edited 1 year ago)

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.

[-] BoneALisa@lemm.ee 2 points 1 year ago

Oh man, you're right! Whoops. I'll go ahead and add that, lol.

I appreciate that! Glad im not doing anything horribly wrong... I'll have to play around with the init script to see how to make it easier to get the needed functions.

I do have a pertinent question I forgot to ask about in my main post if you have some time, though. I am using SocketIO for their realtime API, and needed to figure out how to pass events received from the socket onto the client that is using the wrapper. I opted for requiring callback functions to be registered for the different events we could receive, that way they can choose what functions they want called when we get the event, but is that the best way to do it? I couldn't think of any other method to pass that event in an async fashion, lol.

[-] mvee@lemmy.ml 2 points 1 year ago

I think what you have is the perfect amount of complexity, and easily extendable. I use callbacks like this all the time in my code, but also my users are part of my team at work so they don't have far for help when the callback API isnt clear :P most of my users dont even know callbacks are a thing.

If your list of supported events gets large or you want to cheaply support future changes to the server, you could pass all event names and data through a handler callback and make users handle multiple event types.

One of the things that makes plain callbacks nice is it's an easy way to let your users decide how they want to integrate with your library. If your callbacks are called from a background thread, it's up to the user to figure out how they want to pass the event to other threads. Async users can use their runtime of choice to submit tasks from a callback.

[-] BoneALisa@lemm.ee 2 points 1 year ago

Awesome, thanks for the feedback!

The callbacks not being widely known about was my concern as well, as I had only heard about them when researching a solution for this, lol. I'll probably stick with my solution, and write a page in the documentation describing what they are and how to use them, to hopefully make it clear.