search

pypa / readme_renderer

Safely render long_description/README files in Warehouse
Apache License 2.0
158 stars 88 forks source link

chore: add types #225

Closed miketheman closed 2 years ago

miketheman commented 2 years ago

There's a lot of commits here for a relatively small amount of changes, and it can seem overwhelming at first.

I tried to keep each commit well-scoped, and describe the journey on adding mypy as a testing strategy, correcting the issues surfaced during the initial (non-strict) runs, and then applying stricter rules, until it's finally a fully-typed library.

(I snuck in a pytest warning removal while I was at it.)

Completing this work, and releasing a version should allow us to remove a line in the warehouse config.

Let me know what y'all think!

Resolves #166

miketheman commented 2 years ago

@bhrutledge Thanks for the review!

miketheman commented 2 years ago

@di would appreciate the CI-approval to get the tests running to confirm.

di commented 2 years ago

Released in https://pypi.org/project/readme-renderer/34.0/.