Notes
Hi, fellow Pythonistas!
This package grows bigger and allows you to do more and more with every release! However, entropy grows as well, and we sometimes lack documentation to cover all the changes. As always, `boto3` documentation is not the best place to check if types are correct.
So, now we have [auto-generated docs](https://github.com/vemel/mypy_boto3_builder/service_docs/index.md) for every module. And they are generated with... Yes, `mypy_boto3_builder` can now also generate docs for all `boto3` services!
Also, it will be easier for me to announce if something has changed in `botocore` schemas because docs will be affected.
Let me know how the docs can be improved and do not forget to report bugs!
Added
- `[builder]` `--docs` CLI flag to generate MD documentation
- `[services]` MarkDown docs now have Table of Contents
Changed
- `[builder]` single-value literals inlined for readability, but class in `literals.py` is still available for import
- `[builder]` `black` updated to `21.4b2`
- `[builder]` improved logging setup for easier subclassing
- `[services]` updated auto-generated READMEs
- `[services]` added links to new documentation to all classes and methods docstrings
- `[builder]` typed dictionaries are rendered as classes if they do not have any reserved words
- `[services]` all output typed dictionaries have keys marked as required (use `pyright` to check totality properly)
Fixed
- `[services]` literal values were sorted incorrectly in rare cases
- `[apigatewayv2]` to literals were conflicting because they have no names in `botocore` spec, added generated names
- `[builder]` installation works as it should on `pip 21.x`
- `[fsx]` some literals were not extracted, partially breaking the annotations
- `[services]` circular typed dictionaries were replaced with `Dict[str, Any]` too agressively