knit-graphs
===========

A graph representation of knitted structures where each loop is a node and edges represent yarn and stitch relationships.

.. image:: https://img.shields.io/github/workflow/status/mhofmann-Khoury/knit-graphs/CI
   :target: https://github.com/mhofmann-Khoury/knit-graphs/actions
   :alt: Build Status

.. image:: https://img.shields.io/pypi/v/knit-graphs
   :target: https://pypi.org/project/knit-graphs/
   :alt: PyPI Version

.. image:: https://img.shields.io/pypi/pyversions/knit-graphs
   :target: https://pypi.org/project/knit-graphs/
   :alt: Python Versions

Quick Start
-----------

Installation
~~~~~~~~~~~~

Install from PyPI:

.. code-block:: bash

   pip install knit-graphs

Or install from source:

.. code-block:: bash

   git clone https://github.com/mhofmann-Khoury/knit-graphs.git
   cd your-repo
   poetry install

Documentation Contents
----------------------

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   installation


.. toctree::
   :maxdepth: 4
   :caption: API Reference

   api/knit_graphs

Support and Community
---------------------

* **GitHub Repository**: https://github.com/mhofmann-Khoury/knit-graphs
* **Issue Tracker**: https://github.com/mhofmann-Khoury/knit-graphs/issues
* **PyPI Package**: https://pypi.org/project/knit-graphs/

License
-------

This project is licensed under the MIT License.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`