Description
I'm looking to use this library in a project that uses mypy
, and it looks like currently there are no types available - is this something you'd be open to adding as part of the package?
My understanding is there are three primary ways this can be addressed:
- adding types to the actual code
- shipping stubs next to the code, in
.pyi
files - publishing stubs as a dedicated package, ideally via typeshed
If I understand correctly, provided the package author is onboard with shipping types in their package, doing 2. should be very straightforward, requiring creating a markdownify/__init__.pyi
with some initial type information (which mypy
can generate for you), and maybe including a py.typed
file in the published package.
This means that the types don't need to be perfect from the get-go, and can be easily improved over time - I would be happy to do such a pull request using the basic types I've stubbed out locally.
I don't mind looking at doing 1. or 3. either, but I consider myself something of a guest in the Python ecosystem as I mainly use it for scripts and have not published any packages, so those options feel like they'd required more time and complexity which is why I'm suggesting option 2. to start with