Skip to content

LokiMetaSmith/wireviz-gui

 
 

Repository files navigation

Purpose

To provide an easy-to-use graphical interface for wireviz.

Screenshot

As this was just started, it is pretty basic, but there is lots of potential.

screenshot

Motivation

As you can see, the graphics generated using wireviz are quite good with minimum effort... for those familiar with the command line. I work with many people who would love the output files, but hate the interface and, thus, would not use it.

Pre-Requisites

Install graphviz

Head over to the graphviz download page and install a version of graphviz that suits your system. Most of the guys I'm targetting will use some version of Windows, so I'm doing most of my development there.

I use the winget method.

Be sure that you add the graphviz directory to your PATH (look in environment variables)!!! I had to perform a restart after this step.

Executable

There is an executable available! I built the executable based on the current-day dev branch of wireviz, but it works well enough. Go to the releases, download the wireviz-gui_vX.X.X_YYY.exe and execute. This makes for a nice "try/see" environment.

Installation

This assumes you are familiar with Python, virtual environments, and pip.

  1. Clone this repository:

    git clone https://github.com/slightlynybbled/wireviz-gui
    cd wireviz-gui
  2. Create and activate a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
  3. Install dependencies:

    pip install -r requirements.txt
  4. Run the application:

    python -m wireviz_gui

About

A simple GUI for wireviz

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%