From cea8ac7fce0fa0eebf39f05bae5e29510e14b067 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Tue, 11 Jun 2024 13:11:08 +0200 Subject: [PATCH 1/9] Add .venv to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 8459862..bddaa6e 100644 --- a/.gitignore +++ b/.gitignore @@ -20,6 +20,7 @@ share/python-wheels/ .installed.cfg *.egg MANIFEST +.venv *.manifest *.spec From 346cb386fe39307cf4eda3586318d9a8e1e8b4dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Tue, 11 Jun 2024 13:12:03 +0200 Subject: [PATCH 2/9] Update setup.py - Add readme as long description - Update packages and classifieres, and required python version --- setup.py | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/setup.py b/setup.py index 7b0331f..2abf798 100644 --- a/setup.py +++ b/setup.py @@ -4,21 +4,30 @@ # For details on the licensing terms, see the LICENSE file. # SPDX-License-Identifier: MIT -from setuptools import setup +from setuptools import setup, find_packages +from pathlib import Path +this_directory = Path(__file__).parent +long_description = (this_directory / "README.md").read_text() setup( - name="PFDL Scheduler", - version="0.9.1", - description="Execution engine for Production Flow Description Language (PFDL) files.", + name="pfdl_scheduler", + version="0.9.0", + description="Parser and Scheduler of Production Flow Description Language (PFDL) files.", + long_description=long_description, + long_description_content_type='text/markdown', author="Peter Detzner, Maximilian Hoerstrup", author_email="maximilian.hoerstrup@iml.fraunhofer.de", + python_requires = ">=3.10", + packages=find_packages(), classifiers=[ "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3 :: Only", + "Operating System :: OS Independent", ], install_requires=[ "antlr4-python3-runtime==4.9.3", "antlr-denter", "snakes", + "requests", ], # external packages as dependencies ) From e0919a89f73116d8c08eb12825a2a2824be3ec32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Tue, 11 Jun 2024 13:12:25 +0200 Subject: [PATCH 3/9] Use urls instead of relative paths --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 979cc5e..9670915 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,7 @@ SPDX-License-Identifier: MIT Production Flow Description Language =========================== - -pfdl_logo +pfdl_logo

![Tests](https://github.com/iml130/pfdl/actions/workflows/tests.yml/badge.svg?branch=main) @@ -79,7 +78,7 @@ No PetriNet is generated / there is an error while generating the net > Check if you correctly installed GraphViz (On Windows you need to put the bin folder inside the GraphViz folder into the PATH environment variable. On Ubuntu it should be fine if you install GraphViz via apt-get) ## License -PDFL is licensed under the MIT License. See [LICENSE](LICENSE) for details on the licensing terms. +PDFL is licensed under the MIT License. See [LICENSE](https://github.com/iml130/pfdl/blob/main/LICENSE) for details on the licensing terms. ## Academic Attribution If you use the PFDL for research, please include the following reference in any resulting publication. From 8820aa4bc06d05c749e50d5272456c84ccad55a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Tue, 11 Jun 2024 13:49:53 +0200 Subject: [PATCH 4/9] Add link to pypi package --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 9670915..0264e69 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,10 @@ The Scheduler is the main part of the language. It parses PFDL files and generat For more infos visit the official :books: [Documentation](https://iml130.github.io/pfdl/). +## Quick Installation +The fastest way to get the PFDL Scheduler running is by installing the [PyPi package](https://pypi.org/project/pfdl-scheduler/) via pip: +> pip install pfdl-scheduler + ## Requirements - Pip packages from requirements.txt (`pip install -r requirements.txt`) - [GraphViz](https://graphviz.org/) (if you want to use the scheduler/run the scheduler_demo.py) From 2f8f170e08acf46b523646da595e48912261dc2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Tue, 11 Jun 2024 14:00:24 +0200 Subject: [PATCH 5/9] Update setup.py Co-authored-by: Marius Brehler --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 2abf798..5678ecf 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ setup( name="pfdl_scheduler", version="0.9.0", - description="Parser and Scheduler of Production Flow Description Language (PFDL) files.", + description="Parser and Scheduler for Production Flow Description Language (PFDL) files.", long_description=long_description, long_description_content_type='text/markdown', author="Peter Detzner, Maximilian Hoerstrup", From 0a7bef1808e3bb61dddf6d781a3c969c319e3bf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Tue, 11 Jun 2024 14:06:11 +0200 Subject: [PATCH 6/9] Add recommendation for virtual environments --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0264e69..e623553 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ For more infos visit the official :books: [Documentation](https://iml130.github. The fastest way to get the PFDL Scheduler running is by installing the [PyPi package](https://pypi.org/project/pfdl-scheduler/) via pip: > pip install pfdl-scheduler +However, we recommend the user to install the package inside a [virtual environment](https://docs.python.org/3/library/venv.html). + ## Requirements - Pip packages from requirements.txt (`pip install -r requirements.txt`) - [GraphViz](https://graphviz.org/) (if you want to use the scheduler/run the scheduler_demo.py) From f75d184008c0122ab671e96eb7a89987cefcaa1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Tue, 11 Jun 2024 14:06:23 +0200 Subject: [PATCH 7/9] Use a more general term for the authors --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 5678ecf..41a8933 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ description="Parser and Scheduler for Production Flow Description Language (PFDL) files.", long_description=long_description, long_description_content_type='text/markdown', - author="Peter Detzner, Maximilian Hoerstrup", + author="The PFDL Contributors", author_email="maximilian.hoerstrup@iml.fraunhofer.de", python_requires = ">=3.10", packages=find_packages(), From 5bc49320169ee63ef5a2a14a2a0da5b2da0ab717 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Tue, 11 Jun 2024 15:17:46 +0200 Subject: [PATCH 8/9] Update README.md Co-authored-by: Marius Brehler --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e623553..da39e38 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,9 @@ The Scheduler is the main part of the language. It parses PFDL files and generat For more infos visit the official :books: [Documentation](https://iml130.github.io/pfdl/). ## Quick Installation -The fastest way to get the PFDL Scheduler running is by installing the [PyPi package](https://pypi.org/project/pfdl-scheduler/) via pip: +The fastest way to get the PFDL Scheduler running is by installing the [PyPi package](https://pypi.org/project/pfdl-scheduler/) via pip in a virtual environment: +> python3 -m venv venv-pfdl +> source venv-pfdl/bin/activate > pip install pfdl-scheduler However, we recommend the user to install the package inside a [virtual environment](https://docs.python.org/3/library/venv.html). From 120e471f984b8ee01a73f0d564ffa31b91e50cbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Tue, 11 Jun 2024 15:19:17 +0200 Subject: [PATCH 9/9] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index da39e38..0e7b560 100644 --- a/README.md +++ b/README.md @@ -32,13 +32,11 @@ The Scheduler is the main part of the language. It parses PFDL files and generat For more infos visit the official :books: [Documentation](https://iml130.github.io/pfdl/). ## Quick Installation -The fastest way to get the PFDL Scheduler running is by installing the [PyPi package](https://pypi.org/project/pfdl-scheduler/) via pip in a virtual environment: +The fastest way to get the PFDL Scheduler running is by installing the [PyPi package](https://pypi.org/project/pfdl-scheduler/) via pip in a [virtual environment](https://docs.python.org/3/library/venv.html): > python3 -m venv venv-pfdl > source venv-pfdl/bin/activate > pip install pfdl-scheduler -However, we recommend the user to install the package inside a [virtual environment](https://docs.python.org/3/library/venv.html). - ## Requirements - Pip packages from requirements.txt (`pip install -r requirements.txt`) - [GraphViz](https://graphviz.org/) (if you want to use the scheduler/run the scheduler_demo.py)