add a stub type file

[rambip]

This should close #8

The type annotations are not perfect (for example, boolean types for labels, and no return type), but it should be ok for most uses.

[Skielex]

Thanks for the PR. I'll take a look as soon as I've got time.

[Skielex]

Exactly which command did you use to generate this stub file?

[rambip]

pybind11-stubgen thinqpbo

And then I edited the result manually.

https://pypi.org/project/pybind11-stubgen/

[Skielex]

I haven't created stubs before, so I'm not what the best approach is for Cython projects like this, where we distribute both wheels and sdist.

As far as I can tell this PR does not currently add working stubs to the project. The immediate issue is that the _qbpo.pyi will not be included in any wheels, as the src folder isn't a part of the wheel. When building the Cython extension, the src folder is compiled to a .pyd/.so file.

I've tried moving _qbpo.pyi to the thinqpbo folder so that it's distributed with the package, however, it doesn't seem to work correctly with VS Code.

[Skielex]

Is this solution working for you? Would you be willing to fix the stubs so that they will be correctly included in the package and provide working stubs in applications like VS Code?

[rambip]

It's also my first time packaging a library, so I'm not 100% sure of what I'm doing.
Yet, I think I made it work (minor changes to setup.py)

I also heard that you can add zip_safe=False in the setup.py options (see here)
I don't know if it is needed in our case.

[Skielex]

@rambip , I made some changes and it appears that the stub is now correctly included and it seems to work when I install the package. Could you please check that it works as intended for you?