Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MrBlenny/py-d2
A fully typed python interface for building .d2 graph files for use with the D2 engine.
https://github.com/MrBlenny/py-d2
Last synced: 3 months ago
JSON representation
A fully typed python interface for building .d2 graph files for use with the D2 engine.
- Host: GitHub
- URL: https://github.com/MrBlenny/py-d2
- Owner: MrBlenny
- License: mit
- Created: 2022-12-28T23:41:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T06:23:38.000Z (6 months ago)
- Last Synced: 2024-07-18T23:35:16.118Z (4 months ago)
- Language: Python
- Homepage:
- Size: 622 KB
- Stars: 53
- Watchers: 2
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# py-d2
An unofficial, fully typed python interface for building [.d2](https://github.com/terrastruct/d2) diagram files in python.
## Installation
```bash
pip install py-d2
```
## Usage
```python
from py_d2 import D2Diagram, D2Shape, D2Connection, D2Style
shapes = [
D2Shape(name="shape_name1", style=D2Style(fill="red")),
D2Shape(name="shape_name2", style=D2Style(fill="blue"))]
connections = [
D2Connection(shape_1="shape_name1", shape_2="shape_name2")
]
diagram = D2Diagram(shapes=shapes, connections=connections)
with open("graph.d2", "w", encoding="utf-8") as f:
f.write(str(diagram))
```
produces the following graph.d2 file:
```d2
shape_name1: {
style: {
fill: red
}
}
shape_name2: {
style: {
fill: blue
}
}
shape_name1 -> shape_name2
```
This can be rendered using `d2 graph.d2 graph.svg && open graph.svg` or [https://play.d2lang.com/](https://play.d2lang.com/) to produce
See the [tests](/tests/test_py_d2) for more detailed usage examples.
## Supported Features
- [x] Shapes (nodes)
- [x] Connections (links)
- [x] Styles
- [x] Containers (nodes/links in nodes)
- [x] Shapes in shapes
- [x] Arrow directions
- [x] Markdown / block strings / code in shapes
- [ ] Icons in shapes
- [ ] SQL table shapes
- [ ] Class shapes
- [ ] Comments
## Development
### Prerequisite
- [Python 3.7+](https://www.python.org/)
- [Poetry 1.3](https://python-poetry.org/)
- [pre-commit](https://pre-commit.com/)
### Installation
following the steps below to setup the project:
```bash
```bash
# Clone the repository
git clone [email protected]:MrBlenny/py-d2.git && cd py-d2
# Install all dependencies
poetry install --sync --all-extras --with dev,test,coverage
# install git hook scripts for development
pre-commit install
# Install dependencies with group 'dev'、'test' for development
poetry install --with dev,test
# Only install required dependencies for production
poetry install
```
### Usage
There are some useful commands for development:
```bash
# Run the example
poetry run example
# Debug with ipdb3
poetry run ipdb3 ./src/py_d2/main.py
# Code test
poetry run pytest -s
# Run default coverage test
poetry run tox
# Run example project coverage test at python 3.9 and 3.10
poetry run tox -e py{39,310}-py-d2
# Lint with black
poetry run black ./src --check
# Format code with black
poetry run black ./src
# Check with mypy
poetry run mypy ./src
# Check import order with isort
poetry run isort ./src --check
# Lint with flake8
poetry run flake8 ./src
```