knitout-to-dat-python
=====================

.. image:: https://img.shields.io/pypi/v/knitout-to-dat-python.svg
   :target: https://pypi.org/project/knit-script/
   :alt: PyPI Version

.. image:: https://img.shields.io/pypi/pyversions/knitout-to-dat-python.svg
   :target: https://pypi.org/project/knit-script
   :alt: Python Version

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: License

.. image:: https://img.shields.io/badge/type_checker-mypy-blue.svg
   :target: https://mypy-lang.org/
   :alt: Code style: MyPy

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: Pre-commit

A tool replicating the functionality of the CMU Textile's Lab Knitout-to-Dat Interpreter implemented in Javascript. This python library can convert Knitout files into Shima Seiki DAT files.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started
   :hidden:

   installation
   quickstart

.. toctree::
   :maxdepth: 3
   :caption: API Reference
   :hidden:

   modules.rst

.. toctree::
   :maxdepth: 1
   :caption: Project Information
   :hidden:

   dependencies
   related_projects
   acknowledgments

Quick Navigation
================

**Getting Started**

* :doc:`installation` - Installation instructions for different environments
* :doc:`quickstart` - Your first KnitScript pattern in 5 minutes

**API Documentation**

* :doc:`knitout_to_dat_python` - Complete API reference