Refactoring/image handling

AVATEAM-IT-SYSTEMHAUS / mkdocs-kroki-plugin

MkDocs plugin for Kroki-Diagrams

MIT License

41 stars 27 forks source link

Refactoring/image handling #46

Closed oniboni closed 6 months ago

oniboni commented 8 months ago

fix: downloaded image handling

place referenced image files next to page
take metadata into account for image name generation
update to mkdocs 1.4 plugin config
remove temp dir and download dir
deprecate DownloadImages -> HttpMethod='POST' realizes this functionality as well
- let option automatically set HttpMethod: 'POST' for compatibility
deprecate DownloadDir option to get rid of relative and absolute path issues
move kroki response handling to kroki client
add type hints
docs: update config section

Fixes #11, fixes #32, fixes #39, fixes #41

stanislav-c commented 6 months ago

We have tested this PR and can confirm that it fixes the downloaded image URLs. We use this plugin in our organization and would be grateful if you released a new version of the plugin containing this fix.

karelbemelmans commented 6 months ago

I can also confirm this plugin works for us. Would be nice to get this merged so we can switch from our fork to the upstream release.

Moulick commented 6 months ago

@b-bittner any hopes of getting this in please?

karelbemelmans commented 5 months ago

Just an FYI here: This code change makes the plugin require a higher Python version than 3.8. Our techdocs fail to render with 3.8, but work with 3.10:

Failed example:

    File "/usr/local/lib/python3.8/site-packages/kroki/plugin.py", line 17, in <module>
      from kroki.config import KrokiDiagramTypes
    File "/usr/local/lib/python3.8/site-packages/kroki/config.py", line 6, in <module>
      class KrokiDiagramTypes:
    File "/usr/local/lib/python3.8/site-packages/kroki/config.py", line 61, in KrokiDiagramTypes
      file_types: list[str],
  TypeError: 'type' object is not subscriptable

b-bittner commented 5 months ago

Thanks for your hint, just updated the dependencies.