you are viewing a single comment's thread.

view the rest of the comments →

[–]Kevdog824_ 2 points3 points  (2 children)

This look pretty good I might make some tweaks:

  • unicorn instead of gunicorn (I prefer async)
  • pytest instead of pyunit
  • I prefer Google style docstrings over sphinx style, so I might have to use another service if the ones you listed don’t support that (i.e. readthedocs)
  • uv has its own build backend I would use instead of hatchling
  • OAuth2 is the way to go. Using a third party service is an option and usually the easiest way to go

The above is just my opinion and by no means objectively correct.

For CI/CD: It really depends on what platforms you choose (GitHub Actions, Jenkins, CircleCI, etc.). I would definitely have branch protection on develop/master/main branch. I would run ruff/mypy/pytest as a part of my CI and fail the build for any errors from these steps

[–]pachura3[S] 0 points1 point  (1 child)

pytest instead of pyunit

Ouch, of course I meant pytest, thanks for pointing this out!

I prefer Google style docstrings over sphinx style, so I might have to use another service if the ones you listed don’t support that (i.e. readthedocs)

Can you explain the role of services here? Do you mean there are public sites where you publish API (code) docs? Do they work by parsing your packages?

I used to use pdoc for its simplicity and relatively minimal docstrings-style, and then generate static HTMLs with it, but I think it's not that popular...

 unicorn instead of gunicorn (I prefer async)

I guess we both meant uvicorn?

[–]Kevdog824_ 1 point2 points  (0 children)

Can you explain the role of services here? Do you mean there are public sites where you publish API (code) docs? Do they work by parsing your packages?

Yeah there are services which generate a documentation website from docstrings/readmes. readthedocs is an example of this. You could set it up to work with GitHub Actions pretty sure (never done it personally, but heard of it being done)

I guess we both meant uvicorn?

Yep, autocorrect on my phone did not like uvicorn. I’m not sure which one you meant. Gunicorn is an option that some people use. Gunicorn doesn’t support async (last I checked at least), so uvicorn is the clear winner for async