stub file for Python APIs

[unkcpz]

@relf thanks for the tool, I start using it in our project, and it is really nice. I found it would be helpful to have static typing for the IDE for python API. Here is the PR I tried to add the stub file for the python APIs.

[relf]

Happy to learn the project is useful to you. I am not familiar with typing in Python but open to add support for IDEs.

[unkcpz]

thanks for the quick reply @relf, I'll remove the docstring from the stub file to avoid duplication for now. I also find PyO3/pyo3#2454 which I'll look into a bit. Probably there is easy way to do it better.

[unkcpz]

I also find PyO3/pyo3#2454 which I'll look into a bit. Probably there is easy way to do it better.

I give it a read on the discussion, the pyo3 didn't yet provide a native way to support generate stub file. There is the crate pyo3-stub-gen mentioned and I think it cover well the case of egobox, I give it a try on #237.

[unkcpz]

As discussed in #237, I updated the PR with having the stub file auto generated using pyo3-stub-gen. Since it requires a small change on the auto-gen tool. I separate the PR by having this one only have the change with the auto-gen stub file.

[relf]

Either ruff format manually or configure to exclude egobox.pyi file from ruff formatting as you prefer.

[unkcpz]

I exclude it from ruff check, and seems works in locally. Could you retrigger the tests? Thanks.