seqdiag


Nameseqdiag JSON
Version 3.0.0 PyPI version JSON
download
home_pagehttp://blockdiag.com/
Summaryseqdiag generates sequence-diagram image from text
upload_time2021-12-06 16:56:31
maintainer
docs_urlNone
authorTakeshi Komiya
requires_python>=3.7
licenseApache License 2.0
keywords diagram generator
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            `seqdiag` generate sequence-diagram image file from spec-text file.

.. image:: https://drone.io/bitbucket.org/blockdiag/seqdiag/status.png
   :target: https://drone.io/bitbucket.org/blockdiag/seqdiag
   :alt: drone.io CI build status

.. image:: https://pypip.in/v/seqdiag/badge.png
   :target: https://pypi.python.org/pypi/seqdiag/
   :alt: Latest PyPI version

.. image:: https://pypip.in/d/seqdiag/badge.png
   :target: https://pypi.python.org/pypi/seqdiag/
   :alt: Number of PyPI downloads


Features
========

* Generate sequence-diagram from dot like text (basic feature).
* Multilingualization for node-label (utf-8 only).

You can get some examples and generated images on 
`blockdiag.com <http://blockdiag.com/en/seqdiag/index.html>`__ .

Setup
=====

Use easy_install or pip::

   $ sudo easy_install seqdiag

   Or

   $ sudo pip seqdiag


Copy and modify ini file. example::

   $ cp <seqdiag installed path>/blockdiag/examples/simple.diag .
   $ vi simple.diag

Please refer to `spec-text setting sample`_ section for the format of the
`simpla.diag` configuration file.

spec-text setting sample
========================

Few examples are available.
You can get more examples at
`blockdiag.com <http://blockdiag.com/en/seqdiag/index.html>`__ .

simple.diag
------------

simple.diag is simply define nodes and transitions by dot-like text format::

    diagram {
      browser  -> webserver [label = "GET /index.html"];
      browser <-- webserver;
      browser  -> webserver [label = "POST /blog/comment"];
                  webserver  -> database [label = "INSERT comment"];
                  webserver <-- database;
      browser <-- webserver;
    }


Usage
=====

Execute seqdiag command::

   $ seqdiag simple.diag
   $ ls simple.png
   simple.png


Requirements
============
* Python 3.7 or later
* blockdiag 1.5.0 or later
* funcparserlib 0.3.6 or later
* reportlab (optional)
* wand and imagemagick (optional)
* setuptools


License
=======
Apache License 2.0



            

Raw data

            {
    "_id": null,
    "home_page": "http://blockdiag.com/",
    "name": "seqdiag",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "diagram,generator",
    "author": "Takeshi Komiya",
    "author_email": "i.tkomiya@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9b/66/7d344b87f0a4ce761efe8a16fa41bad28d4685502540899004c5b3ca34ca/seqdiag-3.0.0.tar.gz",
    "platform": "",
    "description": "`seqdiag` generate sequence-diagram image file from spec-text file.\n\n.. image:: https://drone.io/bitbucket.org/blockdiag/seqdiag/status.png\n   :target: https://drone.io/bitbucket.org/blockdiag/seqdiag\n   :alt: drone.io CI build status\n\n.. image:: https://pypip.in/v/seqdiag/badge.png\n   :target: https://pypi.python.org/pypi/seqdiag/\n   :alt: Latest PyPI version\n\n.. image:: https://pypip.in/d/seqdiag/badge.png\n   :target: https://pypi.python.org/pypi/seqdiag/\n   :alt: Number of PyPI downloads\n\n\nFeatures\n========\n\n* Generate sequence-diagram from dot like text (basic feature).\n* Multilingualization for node-label (utf-8 only).\n\nYou can get some examples and generated images on \n`blockdiag.com <http://blockdiag.com/en/seqdiag/index.html>`__ .\n\nSetup\n=====\n\nUse easy_install or pip::\n\n   $ sudo easy_install seqdiag\n\n   Or\n\n   $ sudo pip seqdiag\n\n\nCopy and modify ini file. example::\n\n   $ cp <seqdiag installed path>/blockdiag/examples/simple.diag .\n   $ vi simple.diag\n\nPlease refer to `spec-text setting sample`_ section for the format of the\n`simpla.diag` configuration file.\n\nspec-text setting sample\n========================\n\nFew examples are available.\nYou can get more examples at\n`blockdiag.com <http://blockdiag.com/en/seqdiag/index.html>`__ .\n\nsimple.diag\n------------\n\nsimple.diag is simply define nodes and transitions by dot-like text format::\n\n    diagram {\n      browser  -> webserver [label = \"GET /index.html\"];\n      browser <-- webserver;\n      browser  -> webserver [label = \"POST /blog/comment\"];\n                  webserver  -> database [label = \"INSERT comment\"];\n                  webserver <-- database;\n      browser <-- webserver;\n    }\n\n\nUsage\n=====\n\nExecute seqdiag command::\n\n   $ seqdiag simple.diag\n   $ ls simple.png\n   simple.png\n\n\nRequirements\n============\n* Python 3.7 or later\n* blockdiag 1.5.0 or later\n* funcparserlib 0.3.6 or later\n* reportlab (optional)\n* wand and imagemagick (optional)\n* setuptools\n\n\nLicense\n=======\nApache License 2.0\n\n\n",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "seqdiag generates sequence-diagram image from text",
    "version": "3.0.0",
    "project_urls": {
        "Code": "https://github.com/blockdiag/nwdiag",
        "Download": "http://pypi.python.org/pypi/seqdiag",
        "Homepage": "http://blockdiag.com/",
        "Issue tracker": "https://github.com/blockdiag/nwdiag/issues"
    },
    "split_keywords": [
        "diagram",
        "generator"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3f0c66a3bedcc9fc972031dec8da2a57d92b1970dc58e23ba69178061f73cee3",
                "md5": "732b0c0472d79a20ec2078dd82f766f0",
                "sha256": "8fc941a0badc992766ffb393cf46d56f087e6c58438bc20699e7cdbae202033d"
            },
            "downloads": -1,
            "filename": "seqdiag-3.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "732b0c0472d79a20ec2078dd82f766f0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 2588169,
            "upload_time": "2021-12-06T16:56:29",
            "upload_time_iso_8601": "2021-12-06T16:56:29.448209Z",
            "url": "https://files.pythonhosted.org/packages/3f/0c/66a3bedcc9fc972031dec8da2a57d92b1970dc58e23ba69178061f73cee3/seqdiag-3.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9b667d344b87f0a4ce761efe8a16fa41bad28d4685502540899004c5b3ca34ca",
                "md5": "b495e83f6a0af2c5aa0958bb2723c6e4",
                "sha256": "e15113a28bd075460a62da44e15a88fafa3c81fdf3a35dcd5e3cd64ef15e961a"
            },
            "downloads": -1,
            "filename": "seqdiag-3.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b495e83f6a0af2c5aa0958bb2723c6e4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 2619076,
            "upload_time": "2021-12-06T16:56:31",
            "upload_time_iso_8601": "2021-12-06T16:56:31.452309Z",
            "url": "https://files.pythonhosted.org/packages/9b/66/7d344b87f0a4ce761efe8a16fa41bad28d4685502540899004c5b3ca34ca/seqdiag-3.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-12-06 16:56:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "blockdiag",
    "github_project": "nwdiag",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "seqdiag"
}
        
Elapsed time: 0.49482s