{ "info": { "author": "Bogdan Vukobratovic", "author_email": "bogdan.vukobratovic@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3 :: Only", "Topic :: Documentation", "Topic :: Utilities" ], "description": "\nWelcome to BDP\n==============\n\nBDP (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.\n\n.. image:: https://raw.githubusercontent.com/bogdanvuk/bdp/master/doc/source/images/compile_process.png\n :width: 40%\n\nFigure can be rendered with the `compile_process.py `_ BDP diagram. It can be rendered into the PNG with BDP via command line::\n\n # bdp compile_process.py -p\n\nFor a complete list of command line options please take a look at `command_line `_ chapter of the documentation.\n\nWhy BDP?\n--------\n\nBDP brings following benefits:\n\n- Diagram description in Python which should render it more readable\n- Step-by-step debugging of the diagram description\n- Use the tools and design environments available for Python development (debugging, code completion, refactoring, documentation utilities...)\n- Use vast Python library of packages\n\nBDP features\n------------\n\nBDP package comprises:\n\n- Python classes that wrap the Tikz statements\n- Class for rendering PDF and PNG images from the Python description\n- Shell entry point for rendering BDP images from command line\n- Sphinx extensions for embedding BDP images into the Sphinx documents\n\nImage 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.\n\n.. image:: https://raw.githubusercontent.com/bogdanvuk/bdp/master/doc/source/images/uml.png\n\nFigure can be rendered with the `uml.py `_ BDP diagram.\n\nWhere to start?\n===============\n\nInstallation\n------------\n\nBDP package currently supports only Python 3. Following are alternative ways to install BDP.\n\nInstall BDP using pip::\n\n pip3 install bdp\n\nInstall BDP using easy_install::\n\n easy_install3 bdp\n\nInstall BDP from source::\n\n python3 setup.py install\n\nBDP requires TeX Live, which could be installed on a Debian or a Debian-derived systems, with::\n\n # sudo apt-get install texlive\n\nFor converting PDF to PNG, pdftoppm, pnmcrop and pnmtopng are needed, which could be installed on a Debian or a Debian-derived systems, with::\n\n # sudo apt-get install poppler-utils\n # sudo apt-get install netpbm\n\nRead the documentation\n----------------------\n\nRead the `BDP documentation `_\n\nCheckout the examples\n---------------------\n\nBDP images used in documentation are located in the `images `_ repository documentation folder.\n\nGet involved\n------------\n\nPull your copy from `github repository `_\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/bogdanvuk/bdp/tarball/0.2", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bogdanvuk/bdp", "keywords": "Python,TikZ,Block diagram,PDF,PNG,Sphinx", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "bdp", "package_url": "https://pypi.org/project/bdp/", "platform": "any", "project_url": "https://pypi.org/project/bdp/", "project_urls": { "Download": "https://github.com/bogdanvuk/bdp/tarball/0.2", "Homepage": "https://github.com/bogdanvuk/bdp" }, "release_url": "https://pypi.org/project/bdp/0.2.1/", "requires_dist": [ "pexpect", "sphinx-argparse" ], "requires_python": "", "summary": "Block Diagrams in Python", "version": "0.2.1" }, "last_serial": 4426317, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "6a0684475b9e6be0a07be3bab76e0dfa", "sha256": "8ddf22bb72b4802a14e931db16d62b9e7dc25e5fee6c212568fa92163a8e7e95" }, "downloads": -1, "filename": "bdp-0.1.tar.gz", "has_sig": false, "md5_digest": "6a0684475b9e6be0a07be3bab76e0dfa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26362, "upload_time": "2015-06-08T08:57:49", "url": "https://files.pythonhosted.org/packages/96/18/e3116c8392c3c97726d2a7e248979b0f78c1d503da520b821cccd098ee87/bdp-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "13a6df26f9ea7d1634ba91f2d4a29938", "sha256": "9ecdc32a36420e28a12da6b1b95b2c6e8a692c90e93a2a0709ef8423059190ff" }, "downloads": -1, "filename": "bdp-0.2.tar.gz", "has_sig": false, "md5_digest": "13a6df26f9ea7d1634ba91f2d4a29938", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27330, "upload_time": "2015-06-12T13:40:28", "url": "https://files.pythonhosted.org/packages/84/61/5e3cf5937382c53250754eb489a3de8026d8dd0c523e81ec728e88f00069/bdp-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "b3ccb0a31c7e51d4ae0620df044ad529", "sha256": "75492f67401a558e4bc06bd23d9609833278f282a67c453955338018758ae0bd" }, "downloads": -1, "filename": "bdp-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b3ccb0a31c7e51d4ae0620df044ad529", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 26349, "upload_time": "2018-10-29T06:28:55", "url": "https://files.pythonhosted.org/packages/a2/80/f34d0ea3eaa3bdb6e3f94b1abc529d9c93d3547ec4495e4e955bb422c800/bdp-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d72ec93c697993546a5da4ba74d6a7ee", "sha256": "d27fc2ce48b6c56f5ad13bab260128daa3f6438e4378acf05925c77b51755b75" }, "downloads": -1, "filename": "bdp-0.2.1.tar.gz", "has_sig": false, "md5_digest": "d72ec93c697993546a5da4ba74d6a7ee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29855, "upload_time": "2018-10-29T06:28:57", "url": "https://files.pythonhosted.org/packages/9c/d4/7072a9689e2f338e0b4fa6ec17241091a21e51017463184cb120f7f6b5d8/bdp-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b3ccb0a31c7e51d4ae0620df044ad529", "sha256": "75492f67401a558e4bc06bd23d9609833278f282a67c453955338018758ae0bd" }, "downloads": -1, "filename": "bdp-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "b3ccb0a31c7e51d4ae0620df044ad529", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 26349, "upload_time": "2018-10-29T06:28:55", "url": "https://files.pythonhosted.org/packages/a2/80/f34d0ea3eaa3bdb6e3f94b1abc529d9c93d3547ec4495e4e955bb422c800/bdp-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d72ec93c697993546a5da4ba74d6a7ee", "sha256": "d27fc2ce48b6c56f5ad13bab260128daa3f6438e4378acf05925c77b51755b75" }, "downloads": -1, "filename": "bdp-0.2.1.tar.gz", "has_sig": false, "md5_digest": "d72ec93c697993546a5da4ba74d6a7ee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29855, "upload_time": "2018-10-29T06:28:57", "url": "https://files.pythonhosted.org/packages/9c/d4/7072a9689e2f338e0b4fa6ec17241091a21e51017463184cb120f7f6b5d8/bdp-0.2.1.tar.gz" } ] }