Generates a Graphviz file (or directly creates an SVG) from a Zope/CMF DCWorkflow defintion.
Project description
Automatic Workflow Documentation
Generates a Graphviz file (or directly creates an SVG) from a Zope/CMF DCWorkflow defintion.
Usage:
in ZMI got to the workflow which you want to document.
there are two additional tabs one for raw DOT data file, one for a rendered SVG file.
Features:
generation of Graphviz file with states and transitions.
each state shows a permissions-table
each transition shows its guards.
Todo:
add views to control_panel
Installation
Just depend in your buildout on the egg collective.wfautodoc. When used within Plone ZCML is loaded automagically with `z3c.autoinclude`. Otherwise add the package to buildout section `instance` `zcml` variable.
This package is written for Plone but works also in a pure Zope2/CMF environment.
Source Code and Contributions
If you want to help with the development (improvement, update, bug-fixing, …) of collective.wfautodoc this is a great idea!
The code is located in the github collective.
You can clone it or get access to the github-collective and work directly on the project.
Maintainer is Jens Klein and the BlueDynamics Alliance developer team. We appreciate any contribution and if a release is needed to be done on PyPI, please just contact one of us dev@bluedynamics dot com
Contributors
Jens W. Klein <jens@bluedynamics.com>
History
1.2.0 (2021-07-07)
Some code-style and make it work with Python 3/ Zope 4. [jensens]
Fix bug with special characters in review states. [cedricmessiant]
1.1
not zipsafe, removes superfluos generic setup references. thx to SyZn for contribution. [jensens, 2013-12-03]
1.0
make it work [jensens, 2012-03-01]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for collective.wfautodoc-1.2.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c5a83078302d1fde8409621c27909ab4d7b9e106770f2014003d58f539ecece7 |
|
| MD5 | 3e7d456b610995456228b6b98cb02c6c |
|
| BLAKE2b-256 | 39a7ca0c857cd9cbba885f201be4536dc327b2f16dc2e713b23842ce589a772b |
Hashes for collective.wfautodoc-1.2.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 11c6cf79c8f084d2b18742785d465be8812403a0fbe8b3e86acdfc109415136e |
|
| MD5 | 210a48c4f13bb9c0a3b55c77607de6a9 |
|
| BLAKE2b-256 | 66ad84149a22d101a5780b362484d6623e1f284fad05b81a73ff2b64161963d6 |
