Merge pull request #508 from pm4py/ft-change-to-agpl

Changing license to AGPL

Author: fit-alessandro-berti

CHANGELOG.md

@@ -1,11 +1,22 @@
 # Changelog of pm4py
 
 
-## pm4py 2.7.12 (2024.03.XX)
+## pm4py 2.7.12 (2024.03.21)
 
 ### Added
+* 458ee9abf2fc155a7531be96992c9a0c27f8cb81
+  * maximum number of consecutive occurrences of the same activity in pm4py.get_variants
+* b4c914722605b37f787e156f407ea9333a8dd959
+  * more general between and activity split filters
 
 ### Changed
+* 100b95c22a47eace59fc631541b2c34c9179765d
+  09d4e7a07f92fddd90c1b1bbe572308380d7c8f3
+  * changed BPMN visualizer
+* f7b44a41a79760e4f092be2bf98087ea48b63de4
+  * changed BPMN conversion
+* db98b6fbf16847eceab4b53216cc1a1096936785
+  * improved BPMN support (collaboration, gateways, ...)
 
 ### Deprecated
 
@@ -14,6 +25,10 @@
   * fixing random variables support
 * bb759da149b434d0e279256c8c6d397b06079729
   * fixing sampling
+* a816fb5f000a907b603b44aba1470463109028f0
+  * bug fix OC-DFG visualization
+* 419a95362472c0807b73f4eb3d601f70b3d7c986
+  * bug fix POWL visualizer
 
 ### Removed
 

LICENSE

@@ -1,14 +1,18 @@
-# pm4py
-pm4py is a python library that supports (state-of-the-art) process mining algorithms in python. 
-It is open source (licensed under GPL) and intended to be used in both academia and industry projects.
-pm4py is managed and developed by Process Intelligence Solutions (https://processintelligence.solutions/).
-pm4py was initially developed at the Fraunhofer Institute for Applied Information Technology FIT.
+# PM4Py
+PM4Py is a python library that supports state-of-the-art process mining algorithms in python. 
+It is open source and intended to be used in both academia and industry projects.
+
+PM4Py is managed and developed by Process Intelligence Solutions (https://processintelligence.solutions/),
+a spin-off from the Fraunhofer Institute for Applied Information Technology FIT where PM4Py was initially developed.
+
+Further information on the license options for using PM4Py closed source (especially in industry contexts) can be found at https://processintelligence.solutions/.
+
 
 ## Documentation / API
-The full documentation of pm4py can be found at https://processintelligence.solutions/
+The full documentation of PM4Py can be found at https://processintelligence.solutions/
 
 ## First Example
-A very simple example, to whet your appetite:
+Here is a simple example to spark your interest:
 
 ```python
 import pm4py
@@ -20,30 +24,31 @@ if __name__ == "__main__":
 ```
 
 ## Installation
-pm4py can be installed on Python 3.9.x / 3.10.x / 3.11.x / 3.12.x by invoking:
-*pip install -U pm4py*
+PM4Py can be installed on Python 3.9.x / 3.10.x / 3.11.x / 3.12.x by invoking:
 
-pm4py is also running on older Python environments with different requirements sets, including:
-- Python 3.8 (3.8.10): third_party/old_python_deps/requirements_py38.txt
+`pip install -U pm4py`
+
+PM4Py is also running on older Python environments with different requirements sets, including:
+- Python 3.8 (3.8.10): `third_party/old_python_deps/requirements_py38.txt`
 
 ## Requirements
-pm4py depends on some other Python packages, with different levels of importance:
+PM4Py depends on some other Python packages, with different levels of importance:
 * *Essential requirements*: numpy, pandas, deprecation, networkx
-* *Normal requirements* (installed by default with the pm4py package, important for mainstream usage): graphviz, intervaltree, lxml, matplotlib, pydotplus, pytz, scipy, tqdm
+* *Normal requirements* (installed by default with the PM4Py package, important for mainstream usage): graphviz, intervaltree, lxml, matplotlib, pydotplus, pytz, scipy, tqdm
 * *Optional requirements* (not installed by default): requests, pyvis, jsonschema, workalendar, pyarrow, scikit-learn, polars, openai, pyemd, pyaudio, pydub, pygame, pywin32, pygetwindow, pynput
 
 ## Release Notes
-To track the incremental updates, please refer to the *CHANGELOG* file.
+To track the incremental updates, please refer to the `CHANGELOG.md` file.
 
 ## Third Party Dependencies
 As scientific library in the Python ecosystem, we rely on external libraries to offer our features.
-In the */third_party* folder, we list all the licenses of our direct dependencies.
-Please check the */third_party/LICENSES_TRANSITIVE* file to get a full list of all transitive dependencies and the corresponding license.
+In the `/third_party` folder, we list all the licenses of our direct dependencies.
+Please check the `/third_party/LICENSES_TRANSITIVE` file to get a full list of all transitive dependencies and the corresponding license.
 
-## Citing pm4py
-If you are using pm4py in your scientific work, please cite pm4py as follows:
+## Citing PM4Py
+If you are using PM4Py in your scientific work, please cite PM4Py as follows:
 
-**Alessandro Berti, Sebastiaan van Zelst, Daniel Schuster**. (2023). *PM4Py: A process mining library for Python*. Software Impacts, 17, 100556. [DOI](https://doi.org/10.1016/j.simpa.2023.100556) | [Article Link](https://www.sciencedirect.com/science/article/pii/S2665963823000933)
+> **Alessandro Berti, Sebastiaan van Zelst, Daniel Schuster**. (2023). *PM4Py: A process mining library for Python*. Software Impacts, 17, 100556. [DOI](https://doi.org/10.1016/j.simpa.2023.100556) | [Article Link](https://www.sciencedirect.com/science/article/pii/S2665963823000933)
 
 BiBTeX:
 
@@ -61,3 +66,6 @@ author = {Alessandro Berti and Sebastiaan van Zelst and Daniel Schuster},
 }
 ```
 
+## Legal Notice
+
+This repository is managed by Process Intelligence Solutions (PIS). Further information about PIS can be found online at www.processintelligence.solutions.

README.md

@@ -1,16 +1,21 @@
 '''
-    This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).
+    PM4Py – A Process Mining Library for Python
+Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)
 
-    PM4Py is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or any later version.
 
-    PM4Py is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with PM4Py.  If not, see <https://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see this software project's root or
+visit <https://www.gnu.org/licenses/>.
+
+Website: https://processintelligence.solutions
+Contact: [email protected]
 '''

docs/LICENSE_HEADER_GITHUB.txt

@@ -7,7 +7,7 @@
         for filename in glob.iglob('../pm4py/' + '**/*.py', recursive=True):
             with open(filename, 'r', encoding='utf-8') as original:
                 data = original.read()
-                if (data.find(license) == -1):
+                if "Copyright (C) 2024 Process Intelligence Solutions UG" not in data:
                     with open(filename, 'w', encoding='utf-8') as modified:
                         print('adding license to: ' + filename)
                         modified.write(license + '\n' + data)

docs/header_script.py

@@ -1,18 +1,23 @@
 '''
-    This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).
+    PM4Py – A Process Mining Library for Python
+Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)
 
-    PM4Py is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or any later version.
 
-    PM4Py is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with PM4Py.  If not, see <https://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see this software project's root or
+visit <https://www.gnu.org/licenses/>.
+
+Website: https://processintelligence.solutions
+Contact: [email protected]
 '''
 import time
 

pm4py/__init__.py

@@ -1,17 +1,22 @@
 '''
-    This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).
+    PM4Py – A Process Mining Library for Python
+Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)
 
-    PM4Py is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or any later version.
 
-    PM4Py is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with PM4Py.  If not, see <https://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see this software project's root or
+visit <https://www.gnu.org/licenses/>.
+
+Website: https://processintelligence.solutions
+Contact: [email protected]
 '''
 from pm4py.algo import discovery, conformance, analysis, evaluation, simulation, organizational_mining, transformation

pm4py/algo/__init__.py

@@ -1,17 +1,22 @@
 '''
-    This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).
+    PM4Py – A Process Mining Library for Python
+Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)
 
-    PM4Py is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or any later version.
 
-    PM4Py is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with PM4Py.  If not, see <https://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see this software project's root or
+visit <https://www.gnu.org/licenses/>.
+
+Website: https://processintelligence.solutions
+Contact: [email protected]
 '''
 from pm4py.algo.analysis import extended_marking_equation, marking_equation, workflow_net, woflan

pm4py/algo/analysis/__init__.py

@@ -1,17 +1,22 @@
 '''
-    This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).
+    PM4Py – A Process Mining Library for Python
+Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)
 
-    PM4Py is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or any later version.
 
-    PM4Py is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with PM4Py.  If not, see <https://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see this software project's root or
+visit <https://www.gnu.org/licenses/>.
+
+Website: https://processintelligence.solutions
+Contact: [email protected]
 '''
 from pm4py.algo.analysis.extended_marking_equation import variants

pm4py/algo/analysis/extended_marking_equation/__init__.py

@@ -1,18 +1,23 @@
 '''
-    This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).
+    PM4Py – A Process Mining Library for Python
+Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)
 
-    PM4Py is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or any later version.
 
-    PM4Py is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with PM4Py.  If not, see <https://www.gnu.org/licenses/>.
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see this software project's root or
+visit <https://www.gnu.org/licenses/>.
+
+Website: https://processintelligence.solutions
+Contact: [email protected]
 '''
 from enum import Enum
 from typing import Optional, Dict, Any