iplib3 VS python-ms

Instead of keeping all the code at the repository root, maybe consider a more traditional project structure. As far as examples go, I've got this for an executable, and I think this works for a more complex project.

What that means in practice, I have yet to figure out how to explain in the simplest way possible, but perhaps an example repository might help somewhat. The details more or less boil down to

First, some values simply never change. For example, my iplib3 has plenty of hard-coded constants set by the IPv4 and IPv6 specifications and there's no need to have those in some external config file because, again, unless the standard gets updated those are constant.

I haven't touched this codebase in a while (although I really should), but it serves as one of my better examples for object-oriented programming. It's reasonably large, yet meticulously linted: https://github.com/Diapolo10/iplib3

I don't have any projects using setuptools anymore so unfortunately I can't give an example for that, but if Poetry is fine then iplib3 will probably suffice. Focus on the imports and the project structure, and maybe pyproject.toml, everything else is just noise.

Well, my GitHub profile is part of my flair in this subreddit, feel free to dig around. My latest project was an attempt to port the ms JavaScript library to Python, and I think I did alright. Other things I can highlight would be my iplib3 package, a server implementation for the EguiValet messaging service, and finally I've got a fairly unfinished text colouring utility called escapyde.

And iplib3 could use some cleanup, such as redesigning the inheritance to add support for seamless conversion between all supported types. The documentation should also be written as right now there's basically nothing.

You could maybe take a look at my iplib3 project for some examples. Alternatively, the EguiValet server project should be fine too.

While I have a very recent project that would otherwise be a perfect example, it does something a bit unusual with imports so I'll instead use iplib3 as an example, even though I haven't had time to work on it lately.

The Pytest documentation does a much better job at explaining how this works in practice than I ever could. I don't have any super simple example repositories, but iplib3 might work: https://github.com/Diapolo10/iplib3/blob/main/tests/test_address.py

Traditionally, you import a package and then use things from it to do a task. However, it is actually possible to have the import itself do stuff; I used this technique in python_ms to replicate the original JS module down to its import. And fuckit did it way before that.

As a side note, if you use GitHub Actions or a similar CI/CD system, you can use a matrix or equivalent to create builds or run tests on various different operating systems and Python versions, so you might not even need to worry about running multiple Python versions locally. For example, I use that to build releases for multiple platforms, and to run comprehensive test suites in all configurations.

At first I considered this one, but since it does some funky stuff with sys.path I figured that might confuse you if you started to follow everything to the letter. Otherwise it would probably be more suitable.

I don't really have any simple project examples that use databases (the closest thing would be a certain server project, which is probably too complex for you right now), but to showcase project structure I can suggest python_ms.

I'm also rather fond of GitHub Actions, so I'd create additional scripts for Dependabot updates and some linters/Black to automatically run on every push/pull request. Maybe even automating the PyPI publishing process via Git version tags, and adding releases to GitHub. For that, I believe python_ms is a decent example.

First impressions; I kinda wish the code was in its own subdirectory as generally speaking the repository root is for metadata files/build scripts only. This project will probably serve as a decent example of that.

I also recommend at least looking into letting a CI/CD pipeline handle this for you (for example GitHub Actions) because that way you don't need to expose your API key in the repository, or risk committing secrets in general. As an example, here's my Actions script for uploading new python-ms releases.

Having a pretty README also can't hurt, I'm particularly proud of this one: https://github.com/Diapolo10/python-ms/blob/main/README.md

As far as examples go, I think my EguiValet server project might suffice for this one. It's probably a bit bigger than whatever you're working on, but python_ms would probably be too bare-bones in this case.

If you want an example, python_ms will probably work. I decided to publish on merged pull requests to main instead of waiting for tags (I should probably change that in my template by now), and it's using Poetry, but it's my smallest project that's easy enough to follow in a short time.