dot-to-ascii - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #typescript #llm #machine-learning #deep-learning #linux #nodejs #windows #kubernetes #pytorch #open-source

dot-to-ascii

(★ 509)

Graphviz to ASCII converter using Graph::Easy

File Explorer

Download Latest Version (.zip)

config.php
Dockerfile
dot-load.php
dot-save.php
dot-to-ascii.css
dot-to-ascii.php
index.html
LICENSE
README.md
samples.js
split.min.js

🚀 Installation Guide

1. Get the code

git clone https://github.com/ggerganov/dot-to-ascii

Downloads the entire project code from GitHub to your computer.

cd dot-to-ascii

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t dot-to-ascii .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 dot-to-ascii

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# dot-to-ascii

Try it here: https://dot-to-ascii.ggerganov.com

![dot-to-ascii](https://i.imgur.com/3WLVWn3.png)

## How it works?

- The [index.html](index.html#L82-L95) page sends XHR requests containing your Graphviz input to the [dot-to-ascii.php](dot-to-ascii.php) script
- The [dot-to-ascii.php](dot-to-ascii.php#L8) script runs the [Graph::Easy](https://metacpan.org/pod/Graph::Easy) command line tool to produce a text diagram from the provided Graphviz input
- The result is returned back to [index.html](index.html#L82-L95) where it is displayed in a `<pre>` tag

## API

Dot-to-ascii can be easily used in your code by performing https requests to the api.

### Python

```python
import requests

def dot_to_ascii(dot: str, fancy: bool = True):

url = 'https://dot-to-ascii.ggerganov.com/dot-to-ascii.php'
    boxart = 0

# use nice box drawing char instead of + , | , -
    if fancy:
        boxart = 1

params = {
        'boxart': boxart,
        'src': dot,
    }

response = requests.get(url, params=params).text

if response == '':
        raise SyntaxError('DOT string is not formatted correctly')

return response
```

``` python
graph_dot = '''
    graph {
        rankdir=LR
        0 -- {1 2}
        1 -- {2}
        2 -- {0 1 3}
        3
    }
'''

graph_ascii = dot_to_ascii(graph_dot)

print(graph_ascii)
```

```
                 ┌─────────┐
                 │         │
     ┌───┐     ┌───┐     ┌───┐     ┌───┐
  ┌─ │ 0 │ ─── │ 1 │ ─── │   │ ─── │ 3 │
  │  └───┘     └───┘     │   │     └───┘
  │    │                 │   │
  │    └──────────────── │ 2 │
  │                      │   │
  │                      │   │
  └───────────────────── │   │
                         └───┘
```

## Run locally with docker

This uses the minimal Dockerfile with the default apache config etc. Not
suitable for production use.

``` bash
$ docker build -t dot-to-ascii .
$ docker run --rm -d --name dot-to-ascii -p 8080:80 dot-to-ascii
$ # open localhost:8080 in your browser
```