Block Diagrams in Python
Welcome to BDP
BDP (Block Diagrams in Python) aims to become a Python fronted for TikZ when it comes to drawing block diagrams in order to facilitate the process. BDP wraps the TikZ statements into the Python objects so that users can describe diagrams in pure Python. However, inserting raw TikZ in BDP is also possible. Figure below shows an BDP example image which represents the BDP compilation process.
Figure can be rendered with the compile_process.py BDP diagram. It can be rendered into the PNG with BDP via command line:
# bdp compile_process.py -p
For a complete list of command line options please take a look at command_line chapter of the documentation.
BDP brings following benefits:
Diagram description in Python which should render it more readable
Step-by-step debugging of the diagram description
Use the tools and design environments available for Python development (debugging, code completion, refactoring, documentation utilities…)
Use vast Python library of packages
BDP package comprises:
Python classes that wrap the Tikz statements
Class for rendering PDF and PNG images from the Python description
Shell entry point for rendering BDP images from command line
Sphinx extensions for embedding BDP images into the Sphinx documents
Image below is a more complex example, which shows how power of Python programming can be used to generate diagrams with BDP. Image shows an UML-like diagram of few major BDP templates.
Figure can be rendered with the uml.py BDP diagram.
Where to start?
BDP package currently supports only Python 3. Following are alternative ways to install BDP.
Install BDP using pip:
pip3 install bdp
Install BDP using easy_install:
Install BDP from source:
python3 setup.py install
BDP requires TeX Live, which could be installed on a Debian or a Debian-derived systems, with:
# sudo apt-get install texlive
For converting PDF to PNG, pdftoppm, pnmcrop and pnmtopng are needed, which could be installed on a Debian or a Debian-derived systems, with:
# sudo apt-get install poppler-utils # sudo apt-get install netpbm
Read the documentation
Read the BDP documentation
Checkout the examples
BDP images used in documentation are located in the images repository documentation folder.
Pull your copy from github repository
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.