Metadata-Version: 2.4
Name: promoai
Version: 1.2.1
Summary: ProMoAI: Process Modeling with Generative AI
Home-page: https://github.com/humam-kourani/ProMoAI
Author: Humam Kourani
Author-email: humam.kourani@gmail.com
License: AGPL-3.0-or-later
Keywords: process modeling,business process management,generative AI
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pm4py==2.7.14.2
Requires-Dist: setuptools
Requires-Dist: streamlit
Requires-Dist: requests
Requires-Dist: google-generativeai
Requires-Dist: anthropic
Requires-Dist: rustxes
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# ProMoAI
ProMoAI leverages Large Language Models for the automatic generation of process models. ProMoAI transforms textual descriptions of processes into process models that can be exported in the BPMN and PNML formats. It also supports user interaction by providing feedback on the generated model to refine it. ProMoAI supports three input types:
* *Text:* Provide the initial process description in natural language.
* *Process Model:* Start with an already existing semi-block-structured BPMN or Petri net and use ProMoAI to refine it.
* *Event Log:* Start with an event log in the XES format and the initial process model will be derived using process discovery.

## Launching as a Streamlit App
You have two options for running ProMoAI.
* *On the cloud:* under https://promoai.streamlit.app/.
* *Locally:* by cloning this repository, installing the required environment and packages, and then running 'streamlit run app.py'.

## Installing as a Python Library
Run pip install promoai.

## Requirements

* *Environment:* the app is tested on both Python 3.9 and 3.10.
* *Dependencies:* all required dependencies are listed in the file 'requirements.txt'.
* *Packages:* graphviz.
