https://github.com/csgoh/processpiper
An open source python library to generate business process diagram using code or plain text.
https://github.com/csgoh/processpiper
bpmn business-process diagram-generator diagramming flowchart
Last synced: 6 months ago
JSON representation
An open source python library to generate business process diagram using code or plain text.
- Host: GitHub
- URL: https://github.com/csgoh/processpiper
- Owner: csgoh
- License: mit
- Created: 2023-01-11T04:25:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-02T22:57:15.000Z (over 1 year ago)
- Last Synced: 2025-12-09T15:55:19.254Z (7 months ago)
- Topics: bpmn, business-process, diagram-generator, diagramming, flowchart
- Language: Python
- Homepage: https://github.com/csgoh/processpiper
- Size: 13.2 MB
- Stars: 193
- Watchers: 6
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://en.wikipedia.org/wiki/MIT_License)
[](https://www.codefactor.io/repository/github/csgoh/processpiper)
[](https://twitter.com/CSGohNZ)
# ProcessPiper (Business Process Diagram as Code)
ProcessPiper is an open source python library to generate business process diagram using python code or [PiperFlow](https://github.com/csgoh/processpiper/wiki/Usage-Documentation#syntax) syntax.
Installation
•
Usage Guide
•
Changelogs
## Method 1: Generate business process diagram using English like PiperFlow syntax
This is a sample code to generate a business process diagram using [PiperFlow](https://github.com/csgoh/processpiper/wiki/Usage-Documentation#syntax) syntax.
```python
from processpiper.text2diagram import render
input_syntax = """
title: Sample Test Process
colourtheme: BLUEMOUNTAIN
lane: End User
(start) as start
[Enter Keyword] as enter_keyword
(end) as end
pool: System Search
lane: Database System
[Login] as login
[Search Records] as search_records
as result_found
[Display Result] as display_result
[Logout] as logout
lane: Log System
[Log Error] as log_error
start->login: User \\nAuthenticate
login->enter_keyword: Authenticated
enter_keyword->search_records: Search Criteria
search_records->result_found: Result
result_found->display_result: Yes
display_result->logout->end
result_found->log_error: No
log_error->display_result
footer: Generated by ProcessPiper
"""
render(input_syntax, "my_process_map.png")
```
### Method 2: Generate business process diagram using Python code
This is a sample code to generate a business process diagram using Python code. The code is self-explanatory. The diagram is generated using the default colour theme.
```python
from processpiper import ProcessMap, EventType, ActivityType, GatewayType
with ProcessMap(
"Sample Test Process", colour_theme="BLUEMOUNTAIN") as my_process_map:
with my_process_map.add_lane("End User") as lane1:
start = lane1.add_element("Start", EventType.START)
enter_keyword = lane1.add_element("Enter Keyword", ActivityType.TASK)
with my_process_map.add_pool("System Search") as pool1:
with pool1.add_lane("Database System") as lane2:
login = lane2.add_element("Login", ActivityType.TASK)
search_records = lane2.add_element("Search Records", ActivityType.TASK)
result_found = lane2.add_element("Result Found?", GatewayType.EXCLUSIVE)
display_result = lane2.add_element("Display Result", ActivityType.TASK)
logout = lane2.add_element("Logout", ActivityType.TASK)
end = lane2.add_element("End", EventType.END)
with pool1.add_lane("Log System") as lane3:
log_error = lane3.add_element("Log Error", ActivityType.TASK)
start.connect(login, "User \nAuthenticates").connect(
enter_keyword, "Authenticated"
).connect(search_records, "Search Criteria")
search_records.connect(result_found, "Result").connect(display_result, "Yes")
display_result.connect(logout).connect(end)
result_found.connect(log_error, "No").connect(display_result)
my_process_map.set_footer("Generated by ProcessPiper")
my_process_map.draw()
my_process_map.save("my_process_map.png")
```
The generated diagram is as follows:
# Features
* Generate business process diagrams with Python code
* Alternatively business process diagram can be generated by using PiperFlow
* Business process diagrams contains
* Diagram title
* Pool(s)
* Lane(s)
* Elements:
* Event: Start, End, Timer, Intermediate, Message, Signal, Conditional and Link
* Activity: Task, Subprocess
* Gateway: Inclusive, Exclusive, Parallel, Event
* Support for different colour themes (See [gallery](https://github.com/csgoh/processpiper/wiki/Gallery)) :
* Default
* GREYWOOF
* BLUEMOUNTAIN
* ORANGEPEEL
* GREENTURTLE
* SUNFLOWER
* PURPLERAIN
* RUBYRED
* TEALWATERS
* SEAFOAMS
* Diagrams can be saved to PNG or SVG image formats
* :new::fire: Diagrams can be exported to .bpmn XML file format
## Frontend Application
Two frontend applications have been developed to showcase ProcessPiper capability.
* [Piperoni](https://github.com/csgoh/Piperoni) - A desktop application
* [Piperita](https://piperita.streamlit.app/) - A Streamlit web application
## Support and Community
ProcessPiper is still in the early days of development, if you have any problem, I will try my best to resolve it.
* 📄 Find a solution in our [Wiki](https://github.com/csgoh/processpiper/wiki)
* ⚠️ Open an issue right here on [GitHub](https://github.com/csgoh/processpiper/issues)
Any ideas or suggestions, please send it to me via [GitHub Discussions](https://github.com/csgoh/processmapper/discussions).
## How to Contribute
If you'd like to contribute, start by reading our [Contribution Guide](https://github.com/csgoh/processpiper/tree/main/contributions/CONTRIBUTING.md).
Lets build great software together.