escapyde VS python-ms

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.

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.