https://github.com/cryptaliagy/pyfsa

A CLI utility to render finite state machine graphs and verify strings against finite state machine languages, used for CSI3104 at uOttawa
https://github.com/cryptaliagy/pyfsa

Last synced: 18 days ago
JSON representation

A CLI utility to render finite state machine graphs and verify strings against finite state machine languages, used for CSI3104 at uOttawa

• Host: GitHub
• URL: https://github.com/cryptaliagy/pyfsa
• Owner: cryptaliagy
• License: apache-2.0
• Created: 2021-01-21T21:24:40.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-01-25T20:28:03.000Z (over 5 years ago)
• Last Synced: 2025-08-28T08:58:42.703Z (11 months ago)
• Language: Python
• Homepage:
• Size: 93.8 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# PyFSA

[![Build status badge](https://img.shields.io/github/workflow/status/taliamax/pyfsa/build)](https://github.com/taliamax/pyfsa/actions?query=workflow%3Abuild)

[![Release status badge](https://img.shields.io/github/workflow/status/taliamax/pyfsa/release?label=release)](https://github.com/taliamax/pyfsa/actions?query=workflow%3Arelease)

[![PyPI version badge](https://img.shields.io/pypi/v/pyfsa)](https://pypi.org/project/pyfsa/)

[![PyPI Status Badge](https://img.shields.io/pypi/status/pyfsa)](https://pypi.org/project/pyfsa/)

[![Python versions badge](https://img.shields.io/pypi/pyversions/pyfsa)](https://github.com/taliamax/pyfsa)

[![License](https://img.shields.io/github/license/taliamax/pyfsa)](https://github.com/taliamax/pyfsa/blob/master/LICENSE)

[![Downloads per month](https://img.shields.io/pypi/dm/pyfsa)](https://pypi.org/project/pyfsa/)

A python CLI to render finite state graphs.

This application takes a CSV file with state information, and uses it to either produce the finite state graph, and verify that strings are valid given the state information, a start state, and a desired state. The `string` subcommand is also able to render the traversal graph of a string through the state machine.

## Installation

You can install this project directly from github with `pip`, but it is also available in `pypi`. Install it like so:

```bash

python3 -m pip install pyfsa

```

GraphViz is required to run this, as graphviz is the rendering engine used to create the png files. You can find lots of information on how to do that here: https://graphviz.org/download/

On Ubuntu, you can find it in your package manager or install it directly using APT:

```bash

$ apt install graphviz

```

You might need to also install the graphviz development library to ensure the Python wrapper `pygraphviz` runs properly. You can find more information on installing `pygraphviz` on their [website](https://pygraphviz.github.io). On Ubuntu, you can install it with the following command:

```bash

$ apt install libgraphviz-dev

```

## Examples

State file:

```csv

trigger,source,target

a,x,y

b,x,z

a,y,x

b,y,z

a,z,z

b,z,z

```

```bash

fsa state -f examples/states.csv

```

![no_start_end](examples/no_start_end.png)

```bash

fsa state -f examples/states.csv -s x

```

![start_state](examples/start_state.png)

```bash

fsa state -f examples/states.csv -e z

```

![end_state](examples/end_state.png)

```bash

fsa state -f examples/states.csv -s x -e z

```

![both](examples/both.png)