https://github.com/blockdiag/nwdiag

https://github.com/blockdiag/nwdiag

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/blockdiag/nwdiag
• Owner: blockdiag
• License: apache-2.0
• Created: 2018-05-03T07:50:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-20T06:26:25.000Z (almost 2 years ago)
• Last Synced: 2024-10-01T22:53:56.097Z (about 1 month ago)
• Language: Python
• Size: 2.92 MB
• Stars: 118
• Watchers: 12
• Forks: 20
• Open Issues: 23
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - blockdiag/nwdiag - (others)

README

        
`nwdiag` generate network-diagram image file from spec-text file.

.. image:: https://drone.io/bitbucket.org/blockdiag/nwdiag/status.png

   :target: https://drone.io/bitbucket.org/blockdiag/nwdiag

   :alt: drone.io CI build status

.. image:: https://pypip.in/v/nwdiag/badge.png

   :target: https://pypi.python.org/pypi/nwdiag/

   :alt: Latest PyPI version

.. image:: https://pypip.in/d/nwdiag/badge.png

   :target: https://pypi.python.org/pypi/nwdiag/

   :alt: Number of PyPI downloads

Features

========

* Generate network-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 `_ .

Setup

=====

Use easy_install or pip::

   $ sudo easy_install nwdiag

   Or

   $ sudo pip nwdiag

spec-text setting sample

========================

Few examples are available.

You can get more examples at

`blockdiag.com`_ .

simple.diag

------------

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

    nwdiag {

      network dmz {

          address = "210.x.x.x/24"

          web01 [address = "210.x.x.1"];

          web02 [address = "210.x.x.2"];

      }

      network internal {

          address = "172.x.x.x/24";

          web01 [address = "172.x.x.1"];

          web02 [address = "172.x.x.2"];

          db01;

          db02;

      }

    }

Usage

=====

Execute nwdiag command::

   $ nwdiag 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