Metadata-Version: 2.4
Name: k3kroki
Version: 0.1.2
Summary: Convert diagrams to images via the kroki.io API — zero local dependencies
Author-email: Zhang Yanpo <drdr.xp@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/pykit3/k3kroki
Project-URL: Documentation, https://k3kroki.readthedocs.io
Keywords: diagram,kroki,graphviz,mermaid,plantuml,svg,png
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: resvg-py>=0.2
Requires-Dist: Pillow>=10.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: numpy; extra == "dev"
Requires-Dist: scikit-image; extra == "dev"
Requires-Dist: Pillow; extra == "dev"
Provides-Extra: publish
Requires-Dist: build; extra == "publish"
Requires-Dist: twine; extra == "publish"
Requires-Dist: pk3; extra == "publish"
Provides-Extra: docs
Requires-Dist: mkdocs>=1.5; extra == "docs"
Requires-Dist: mkdocs-material>=9.0; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
Dynamic: license-file

# k3kroki

[![Action-CI](https://github.com/pykit3/k3kroki/actions/workflows/python-package.yml/badge.svg)](https://github.com/pykit3/k3kroki/actions/workflows/python-package.yml)
[![Documentation Status](https://readthedocs.org/projects/k3kroki/badge/?version=stable)](https://k3kroki.readthedocs.io/en/stable/?badge=stable)
[![Package](https://img.shields.io/pypi/pyversions/k3kroki)](https://pypi.org/project/k3kroki)

Convert diagrams to images via the kroki.io API — zero local dependencies

k3kroki is a component of [pykit3] project: a python3 toolkit set.

k3kroki converts diagrams to images via the free kroki.io HTTP API — no local tools needed.


# Install

```
pip install k3kroki
```

# Synopsis

```python
import k3kroki

# Render a Graphviz diagram to SVG bytes
svg = k3kroki.convert("graphviz", "digraph { a -> b }")

# Render a Mermaid diagram and save to file
k3kroki.convert_to_file("mermaid", "graph TD\n  A --> B", "diagram.svg")

# Render PlantUML to PNG
png = k3kroki.convert("plantuml", "@startuml\nAlice -> Bob: hello\n@enduml", "png")
```

#   Author

Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>

#   Copyright and License

The MIT License (MIT)

Copyright (c) 2015 Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>


[pykit3]: https://github.com/pykit3
