escapyde VS iplib3

Personally I split this up even further nowadays into a separate group for tests (such as here).

It's a bit too late for me to give a proper explanation right now, but if an example repository is enough: https://github.com/Diapolo10/escapyde

The established convention is to have metadata files in the repository root, and the project source code nested a level deeper. escapyde would be a fairly simple example of that.

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.

I wrote something similar for escapyde, which could be repurposed to do exactly that. See the escape_format function.

I don't have any Twine examples of my own, but here's one using GitHub Actions to upload files to PyPI: https://github.com/Diapolo10/escapyde

Take my escapyde-project as a small example. The README is at least somewhat helpful, the code files are in a dedicated folder while the root just contains metadata, the dependencies are properly listed in pyproject.toml (could be just requirements.txt in your case, if you want to keep things simple), and the code itself is split across multiple files to make it easier to find what you're looking for. Though admittedly I haven't had time to write proper documentation for it.

Here's one of my own that's pretty small but decently designed: https://github.com/Diapolo10/escapyde

While not quite an executable, you can take a look at my escapyde library as an example. In every release I've bundled in a pre-compiled wheel (analogous to your executable), and a source distribution. Anyone can freely download any of these.

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