escapyde VS 5G00EV25-3001_server

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.

I was looking through this and didn't see anything off at first, so I went to look at the tests of one of my own FastAPI projects.

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.

For example, my EguiValet project uses UUID v4 for various things: https://github.com/Diapolo10/5G00EV25-3001_server/blob/main/eguivalet_server/models.py

If you'd like to see more practical examples I've got a repo dedicated to simple unit testing here and a more advanced example here. Both of them also have GitHub Actions scripts that auto-run tests on every commit and pull request, not to mention linters, and they can generate new releases on both PyPI and GirHub.

`dependabot.yml|

I... honestly am not the best person to answer that. While I don't always write documentation properly for my personal projects, either (at least initially), I've never really had a problem writing it once I start so I've never had to look up guides for it. My co-workers are very pleased with my style regardless for whatever reason. But from the same example project, you can take a look at how I wrote some documentation for it: https://github.com/Diapolo10/5G00EV25-3001_server/blob/main/docs/index.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.

That said, pytest is pretty much the industry standard (because it has almost no boilerplate) so I recommend learning that. As far as examples go, ironically I've got a project specifically for showcasing unit testing which I made during a university course, but for real-world tests my EguiValet server is probably the best example I have readily available.

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.

My EguiValet server project could use a hand in writing more tests, and it's currently missing proper authentication. The current plan is to use fastapi-users, but I haven't had time to implement it.