Skip to main content

Schemdraw Markdown - A simpler way to document simple circuits in markdown.

Project description

Schemdraw Extension for Python-Markdown

a simpler way to document circuits in markdown

Inspiration: This project is inspired by the wonderful project: plantuml-markdown. So, shoutout to the folks who've toiled on that project to make it great!

Usage

This package allows you to configure a schematic drawing, directly in markdown using a code-fenced sample as follows:

::schemdraw:: alt="My super diagram"
    += elm.Resistor().right().label('1Ω')
    += elm.Capacitor().down().label('10μF')
    += elm.Line().left()
    += elm.SourceSin().up().label('10V')
::end-schemdraw::

:warning: Security Note

This package makes use of Python's exec functionality, which is inherently somewhat insecure, as it allows for arbitrary code execution. Only carfully curated drawings logic should be used.

Installation

Installing from PyPI

Yeah! It's "official," now! You can just pip-install the package with:

$ pip3 install schemdraw-markdown

Installing from Source

  1. Clone Repository
  2. From within local Repository folder, issue:
pip install .

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

schemdraw-markdown-0.0.3.tar.gz (6.3 kB view hashes)

Uploaded source

Built Distribution

schemdraw_markdown-0.0.3-py2.py3-none-any.whl (6.0 kB view hashes)

Uploaded py2 py3

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