Metadata-Version: 2.1
Name: pmkoalas
Version: 0.2
Summary: A process mining library that focuses on providing pythonic interactions with event logs and languages.
Author: Adam Burke
Author-email: Adam Banham <adam_banham@hotmail.com>
License: MIT License
        
        Copyright (c) 2022 Adam Peter Banham
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/AdamBanham/koalas
Project-URL: Bug Tracker, https://github.com/AdamBanham/koalas/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# pmkoalas: A Process Mining Project
[![Python 3.[9,10,11]](https://github.com/AdamBanham/koalas/actions/workflows/python-version.yml/badge.svg?branch=main)](https://github.com/AdamBanham/koalas/actions/workflows/python-version.yml)   [![Testing](https://github.com/AdamBanham/koalas/actions/workflows/python-unittests.yml/badge.svg)](https://github.com/AdamBanham/koalas/actions/workflows/python-unittests.yml)


`pmkoalas` provides data structures for process mining research in a well-organized pythonic style.

## Current Features
* Event log structures
    * Importing and exporting of logs to XES formatted XML
    * Several views/types of log
        * Simplified logs
            * This type only considers sequences of process 
            activities, and nothing else.
        * Complex logs
            * This type considers sequences of events. Where 
            an event is a mapping of data. This log type can 
            always be reduced to the simplified type.
    * Generating logs quickly delimited string
        * currently only supports simplified logs
* Process model structures
    * Petri nets
        * exporting to pnml
        * creating dot files for a net
        * generation of a net using fragments of desirable 
        behaviour
* Process discovery techniques
    * Generating a directly follows language from a log
    * The Alpha miner (original variant)

# Development Information
To install dependencies:

`py -m pip install -e .[dev]`

## Testing
To run tests:

`py -m unittest`

# The values of the team

## Postel's law

"Be liberal in what you accept, and conservative in what you send"

[https://en.wikipedia.org/wiki/Jon_Postel](cite)

Branches off main are meant to be either merged in a timely manner,
or show off a potential feature, or should be removed/released back
into the wild.

Features need a use case or a user before they can be explored
in detail.

It is better to delete code that is not used, than to keep it
around. You have written it once, you will write it better the 
next time. Don't be afraid to let it go.
