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 files for collective.wfautodoc 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| collective.wfautodoc-1.2.0.tar.gz | 10.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| collective.wfautodoc-1.2.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 21.8 kB
Release files / collective.wfautodoc-1.2.0.tar.gz
| Download URL | collective.wfautodoc-1.2.0.tar.gz |
|---|---|
| Size | 10.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c5a83078302d1fde8409621c27909ab4d7b9e106770f2014003d58f539ecece7
|
|
BLAKE2b-256 checksum How to use checksums |
39a7ca0c857cd9cbba885f201be4536dc327b2f16dc2e713b23842ce589a772b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.7
|
Release files / collective.wfautodoc-1.2.0-py2.py3-none-any.whl
| Download URL | collective.wfautodoc-1.2.0-py2.py3-none-any.whl |
|---|---|
| Size | 11.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
11c6cf79c8f084d2b18742785d465be8812403a0fbe8b3e86acdfc109415136e
|
|
BLAKE2b-256 checksum How to use checksums |
66ad84149a22d101a5780b362484d6623e1f284fad05b81a73ff2b64161963d6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.7
|
Security for collective.wfautodoc 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
