Skip to main content

WaveDrom compatible python command line

Project description

WaveDromPy

WaveDrom compatible python module and command line.

This tool is intended for people who don't want to install the Node.js environment just to use WaveDrom as simple command line.

This tool is a direct translation of original Javascript file WaveDrom.js to Python. No extra feature added.

WaveDromPy directly converts WaveDrom compatible JSON files into SVG format.

Build Status PyPI version

Usage

WaveDromPy can be called directly:

  wavedrompy source < input.json > svg < output.svg >

or via the wrapper script WaveDromEditor(.exe) for compatibility with the original WaveDrom command line:

  WaveDromEditor source < input.json > svg < output.svg >

WaveDromEditor is a script wrapper to be used with Linux. WaveDromEditor.exe is a script wrapper to be used with Cygwin.

Important notice

The command line uses Python's JSON interpreter that is more restrictive than that of original WaveDrom application.

  • All strings have to be written between quotes (""),
  • Extra comma (,) not supported at end of lists or dictionaries,
  • Only SVG output format supported so far,
  • WaveDromPy doesn't support the schematic drawing feature yet,
  • WaveDromPy was tested with Python V2.7.12 and Python V3.4.5 under both Cygwin and Ubuntu.

Installation

pip install wavedrom

AsciiDoctor example

An AsciiDoctor example is provided to directly generate timing diagrams from AsciiDoctor formatted documents.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wavedrom-0.0.7.tar.gz (115.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page