Metadata-Version: 2.1
Name: knitout-interpreter
Version: 0.1.3
Summary: Support for interpreting knitout files used for controlling automatic V-Bed Knitting machines.
Home-page: https://mhofmann-khoury.github.io/knitout_interpreter/
License: MIT
Keywords: knit,machine knit,textile,Northeastern,ACT Lab,fabrication,knitout
Author: Megan Hofmann
Author-email: m.hofmann@northeastern.edu
Maintainer: Megan Hofmann
Maintainer-email: m.hofmann@northeastern.edu
Requires-Python: >=3.11,<3.14
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Requires-Dist: importlib_resources (>=6.5)
Requires-Dist: knit-graphs (>=0.0.11)
Requires-Dist: parglare (>=0.19.0)
Requires-Dist: virtual-knitting-machine (>=0.0.25)
Project-URL: Documentation, https://mhofmann-khoury.github.io/knitout_interpreter/
Project-URL: Repository, https://github.com/mhofmann-Khoury/knitout_interpreter
Description-Content-Type: text/markdown

# knitout-interpreter

[![PyPI - Version](https://img.shields.io/pypi/v/knitout-interpreter.svg)](https://pypi.org/project/knitout-interpreter)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/knitout-interpreter.svg)](https://pypi.org/project/knitout-interpreter)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Documentation](https://img.shields.io/badge/docs-github.io-blue)](https://mhofmann-khoury.github.io/knitout_interpreter/)

A Python library for interpreting, executing, and debugging [knitout](https://textiles-lab.github.io/knitout/knitout.html) files used to control automatic V-Bed knitting machines.

## Installation
```bash
pip install knitout-interpreter
```

## Quick Example
```python
from knitout_interpreter.run_knitout import run_knitout

# Execute a knitout file
instructions, machine, knit_graph = run_knitout("pattern.k")
```

## Documentation

**Full documentation:** [https://mhofmann-khoury.github.io/knitout_interpreter/](https://mhofmann-khoury.github.io/knitout_interpreter/)

## Links

- **PyPI**: https://pypi.org/project/knitout-interpreter
- **Documentation**: https://mhofmann-khoury.github.io/knitout_interpreter/
- **Source Code**: https://github.com/mhofmann-Khoury/knitout_interpreter
- **Issues**: https://github.com/mhofmann-Khoury/knitout_interpreter/issues

---

**Made by the Northeastern University ACT Lab**

