Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable package release #57

Merged
merged 9 commits into from
Jun 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ share/python-wheels/
.installed.cfg
*.egg
MANIFEST
.venv

*.manifest
*.spec
Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ SPDX-License-Identifier: MIT

Production Flow Description Language
===========================

<img src="docs/img/pfdl_logo_without_font.png" alt="pfdl_logo" width="600"/>
<img src="https://github.com/iml130/pfdl/blob/main/docs/img/pfdl_logo_without_font.png?raw=true" alt="pfdl_logo" width="600"/>
<br><br>

![Tests](https://github.com/iml130/pfdl/actions/workflows/tests.yml/badge.svg?branch=main)
Expand All @@ -32,6 +31,12 @@ 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](https://docs.python.org/3/library/venv.html):
> python3 -m venv venv-pfdl
> source venv-pfdl/bin/activate
> 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)
Expand Down Expand Up @@ -79,7 +84,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.
marbre marked this conversation as resolved.
Show resolved Hide resolved

## Academic Attribution
If you use the PFDL for research, please include the following reference in any resulting publication.
Expand Down
19 changes: 14 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
author="Peter Detzner, Maximilian Hoerstrup",
name="pfdl_scheduler",
version="0.9.0",
description="Parser and Scheduler for Production Flow Description Language (PFDL) files.",
long_description=long_description,
long_description_content_type='text/markdown',
author="The PFDL Contributors",
author_email="[email protected]",
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
)
Loading