Setup Python client PoC

lampajr commented 7 months ago

First draft of a possible python client library of Horreum.

Autogenerated client code using kiota (we can switch to other generators as well)
Automate the client code generation in a Github workflow
Setup simple CI to check that the build works
Setup simple integration tests that require Horreum instance up and running in the background (not automated yet)
No high level api at the moment, right now we need to use the underlying (and autogenerated) raw client

Further improvements (that could be done in different PRs if we agree):

[ ] Manage project version
[ ] Setup release process
[ ] Migrate from keycloak to a generic oidc library
[ ] Implement high level api (right now we can use the raw api)
[ ] Automate Horreum startup for ITs
[ ] PR checks with ITs, needs full automation to make this working
[ ] Consider using nox for test automation in multipl py envs
[ ] Full Horreum API coverage (I would suggest the high level one)

lampajr commented 7 months ago

Hey @stalep, I think this this could be a good starting point/PoC that showcase how the python library could be implemented.

For sure there are many improvements and changes required, I tried to list some of them in the description.

lampajr commented 7 months ago

Squashed all commits into https://github.com/Hyperfoil/horreum-client-python/commit/486c86caeaa8b1e3bdd28c61e20d80b7cb86b93d

mfleader commented 7 months ago

It seems like all of the generated code in this pull request should instead exist as an artifact in CI rather than live in the repo.

stalep commented 7 months ago

It seems like all of the generated code in this pull request should instead exist as an artifact in CI rather than live in the repo.

We have discussed that and yes, that's the ideal, but for now we want to prioritize to get out a client and most consumers would not look at this repo directly but rather download the client over pypi and use it.

lampajr commented 7 months ago

@stalep @webbnh @mfleader I was able to address the exclusion of the generated code (issue https://github.com/Hyperfoil/horreum-client-python/issues/3) as part of this PR as it did not require much effort, this way this PR is much smaller and the final wheel is actually the same as before.

At the moment I'd keep the openapi.yaml committed here.

Moreover I created a publish workflow that aims to automate the publication of the package to Pypi, I still need to figure out if we need to create the package before the first publication or not.

Hyperfoil / horreum-client-python

Setup Python client PoC #2