{ "info": { "author": "Paylogic International", "author_email": "developers@paylogic.com", "bugtrack_url": null, "classifiers": [], "description": "sphinx-scruffy: Plug-in for Sphinx to render \"scruffy\" diagrams\n===============================================================\n\nPlug-in for Sphinx to render \"scruffy\" diagrams.\n\n.. image:: https://api.travis-ci.org/paylogic/sphinx-scruffy.png\n :target: https://travis-ci.org/paylogic/sphinx-scruffy\n.. image:: https://pypip.in/v/sphinx-scruffy/badge.png\n :target: https://crate.io/packages/sphinx-scruffy/\n.. image:: https://coveralls.io/repos/paylogic/sphinx-scruffy/badge.png?branch=master\n :target: https://coveralls.io/r/paylogic/sphinx-scruffy\n\n\nInstallation\n------------\n\n.. sourcecode::\n\n pip install sphinx-scruffy\n\nTo use scruffy diagrams you need several external dependencies installed:\n\n- The `Scruffy Python module `_. This module will be installed automatically when\n you use ``pip install sphinx-scruffy``.\n- You need ``dot`` (Graphviz), ``rsvg-convert`` (librsvg) and ``pic2plot`` (plotutils).\n You can install all three with one command on Ubuntu: ``sudo apt-get install graphviz librsvg2-bin plotutils``.\n- The scruffy font is called Purisa, if you're running Ubuntu you probably have it already but if you don't then\n you can install it using ``sudo apt-get install ttf-thai-tlwg``.\n\n\nConfiguration\n-------------\n\nAn example of your shpinx's conf.py:\n\n.. code-block:: python\n\n extensions = ['sphinx_scruffy']\n\n\nUsage\n-----\n\nThis section shows a few examples of \"scruffy\" diagrams done using shpinx-scruffy plugin.\n\nA simple example\n****************\n\nThe following reStructuredText::\n\n .. scruffy::\n\n [User|+Forename;+Surname;+HashedPassword;-Salt|+Login();+Logout()]\n\nResults in this image:\n\n.. scruffy::\n\n [User|+Forename;+Surname;+HashedPassword;-Salt|+Login();+Logout()]\n\nMore complex example\n********************\n\nHere's a more complex example::\n\n .. scruffy::\n\n [note: You can stick notes on diagrams too!{bg:cornsilk}]\n [Customer]<>1-orders 0..*>[Order]\n [Order]++*->[LineItem]\n [Order]-1>[DeliveryMethod]\n [Order]-*>[Product]\n [Category]<->[Product]\n [DeliveryMethod]^[National]\n [DeliveryMethod]^[International]\n\nThis results in the following image:\n\n.. scruffy::\n\n [note: You can stick notes on diagrams too!{bg:cornsilk}]\n [Customer]<>1-orders 0..*>[Order]\n [Order]++*->[LineItem]\n [Order]-1>[DeliveryMethod]\n [Order]-*>[Product]\n [Category]<->[Product]\n [DeliveryMethod]^[National]\n [DeliveryMethod]^[International]\n\nClass diagram extensions\n************************\n\nHere's how to create class diagrams::\n\n .. scruffy::\n\n [Node A]->[Node B]\n [Node B]->[Node C]\n [Group [Node A][Node B]]\n\nThis results in the following image:\n\n.. scruffy::\n\n [Node A]->[Node B]\n [Node B]->[Node C]\n [Group [Node A][Node B]]\n\nSequence diagrams\n*****************\n\nFinally there are sequence diagrams::\n\n .. scruffy::\n :sequence:\n\n [Patron]order food>[Waiter]\n [Waiter]order food>[Cook]\n [Waiter]serve wine>[Patron]\n [Cook]pickup>[Waiter]\n [Waiter]serve food>[Patron]\n [Patron]pay>[Cashier]\n\nThis results in the following image:\n\n.. scruffy::\n :sequence:\n\n [Patron]order food>[Waiter]\n [Waiter]order food>[Cook]\n [Waiter]serve wine>[Patron]\n [Cook]pickup>[Waiter]\n [Waiter]serve food>[Patron]\n [Patron]pay>[Cashier]\n\n\nPython3 support\n---------------\n\nPackage itself supports python3 out of the box, but it's dependency, scruffy package, doesn't yet have a pypi release\nwith python 3 support.\nuse git master for now https://github.com/aivarsk/scruffy.git\n\nor via pip::\n\n.. code-block:: sh\n\n pip install -e git+https://github.com/aivarsk/scruffy.git#egg=scruffy\n\n\nContact\n-------\n\nIf you have questions, bug reports, suggestions, etc. please create an issue on\nthe `GitHub project page `_.\n\n\nLicense\n-------\n\nThis software is licensed under the `MIT license `_\n\nSee ``_\n\n\n\u00a9 2013 Paylogic International.\n\nChangelog\n=========\n\n\n1.0.0\n-----\n\n- packaging fixes (bubenkoff)\n\n\n0.2\n---\n\n* Initial public release", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "UNKNOWN", "keywords": "sphinx scruffy diagrams documentation", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "sphinx-scruffy", "package_url": "https://pypi.org/project/sphinx-scruffy/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/sphinx-scruffy/", "project_urls": { "Download": "UNKNOWN", "Homepage": "UNKNOWN" }, "release_url": "https://pypi.org/project/sphinx-scruffy/1.0.0/", "requires_dist": null, "requires_python": null, "summary": "Plug-in for Sphinx to render \"scruffy\" diagrams.", "version": "1.0.0" }, "last_serial": 1216849, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "9750517e991dfe2a7e5b47328299eb50", "sha256": "0cd8d80507cfc4809d38262f283dab3084f0daa8ee61108880f9889cbdb38e19" }, "downloads": -1, "filename": "sphinx-scruffy-1.0.0.tar.gz", "has_sig": false, "md5_digest": "9750517e991dfe2a7e5b47328299eb50", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4752, "upload_time": "2014-09-08T12:05:04", "url": "https://files.pythonhosted.org/packages/3a/a3/e8daee0fe03695168c70eb3fd8c19e2b08e00bba955da9f7f4f2918f3e1d/sphinx-scruffy-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9750517e991dfe2a7e5b47328299eb50", "sha256": "0cd8d80507cfc4809d38262f283dab3084f0daa8ee61108880f9889cbdb38e19" }, "downloads": -1, "filename": "sphinx-scruffy-1.0.0.tar.gz", "has_sig": false, "md5_digest": "9750517e991dfe2a7e5b47328299eb50", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4752, "upload_time": "2014-09-08T12:05:04", "url": "https://files.pythonhosted.org/packages/3a/a3/e8daee0fe03695168c70eb3fd8c19e2b08e00bba955da9f7f4f2918f3e1d/sphinx-scruffy-1.0.0.tar.gz" } ] }