knit-graphs 0.0.5__py3-none-any.whl → 0.0.7__py3-none-any.whl

docs/source/index.rst

@@ -0,0 +1,71 @@
+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`

docs/source/installation.rst

@@ -0,0 +1,67 @@
+Installation
+============
+
+Requirements
+------------
+
+* Python 3.11 or higher
+* pip or Poetry package manager
+* networkx for Graph data structures.
+* plotly for Knit Graph visualization
+
+Install from PyPI
+-----------------
+
+The easiest way to install the package is from PyPI:
+
+.. code-block:: bash
+
+   pip install knit-graphs
+
+Or using Poetry:
+
+.. code-block:: bash
+
+   poetry add knit-graphs
+
+Install from Source
+-------------------
+
+To install the latest development version from source:
+
+.. code-block:: bash
+
+   git clone https://github.com/mhofmann-Khoury/knit-graphs.git
+   cd your-repo
+   pip install -e .
+
+Or with Poetry:
+
+.. code-block:: bash
+
+   git clone https://github.com/mhofmann-Khoury/knit-graphs.git
+   cd your-repo
+   poetry install
+
+Development Installation
+------------------------
+
+For development and contributing:
+
+.. code-block:: bash
+
+   git clone https://github.com/mhofmann-Khoury/knit-graphs.git
+   cd your-repo
+   poetry install --with dev,docs
+
+This installs the package with all development dependencies including testing and documentation tools.
+
+Verify Installation
+-------------------
+
+To verify the installation worked correctly:
+
+.. code-block:: python
+
+   import knit-graphs
+   print(knit-graphs.__version__)

knit_graphs/Course.py

@@ -1,104 +1,156 @@
-"""Course representation of a section of knitting with no parent loops."""
-from knit_graphs.Loop import Loop
-
-
-class Course:
-    """
-    Course object for organizing loops into knitting rows
-    """
-
-    def __init__(self):
-        self.loops_in_order: list[Loop] = []
-        self._loop_set: dict[Loop, Loop] = {}
-
-    def add_loop(self, loop: Loop, index: int | None = None):
-        """
-        Add the loop at the given index or to the end of the course
-        :param loop: loop to add
-        :param index: index to insert at or None if adding to end
-        """
-        for parent_loop in loop.parent_loops:
-            assert parent_loop not in self, f"{loop} has parent {parent_loop}, cannot be added to same course"
-        self._loop_set[loop] = loop
-        if index is None:
-            self.loops_in_order.append(loop)
-        else:
-            self.loops_in_order.insert(index, loop)
-
-    def has_increase(self) -> bool:
-        """
-        :return: True if course has at least one yarn over to start new wales.
-        """
-        for loop in self:
-            if not loop.has_parent_loops():  # Yarn over
-                return True
-        return False
-
-    def has_decrease(self) -> bool:
-        """
-        :return: True if course has at least one decrease, merging two wales
-        """
-        for loop in self:
-            if len(loop.parent_loops) > 1:
-                return True
-        return False
-
-    def has_terminal_loop(self, knit_graph) -> bool:
-        """\
-        :param knit_graph: Knit graph to get child loop data from
-        :return: True if this course contains a terminal loop with no child
-        """
-        for loop in self:
-            if knit_graph.get_child_loop(loop) is None:
-                return True
-        return False
-
-    def __getitem__(self, index: int | slice) -> Loop | list[Loop]:
-        return self.loops_in_order[index]
-
-    def index(self, loop: Loop) -> int:
-        """
-        Searches for index of given loop_id
-        :param loop: loop_id or loop to find
-        :return: index of the loop_id
-        """
-        return self.loops_in_order.index(loop)
-
-    def in_round_with(self, next_course) -> bool:
-        """
-        :param next_course: another course who should follow this course
-        :return: True if the next course starts at the beginning of this course
-        """
-        next_start = next_course[0]
-        i = 1
-        while not next_start.has_parent_loops():
-            next_start = next_course[i]
-            i += 1
-        return self[0] in next_start.parent_loops
-
-    def in_row_with(self, next_course) -> bool:
-        """
-        :param next_course: another course that should follow this course.
-        :return: True if the next course starts at the end of this course.
-        """
-        next_start = next_course[0]
-        i = 1
-        while not next_start.has_parent_loops():
-            next_start = next_course[i]
-            i += 1
-        return self[-1] in next_start.parent_loops
-
-    def __contains__(self, loop: Loop) -> bool:
-        return loop in self._loop_set
-
-    def __iter__(self):
-        return self.loops_in_order.__iter__()
-
-    def __len__(self):
-        return len(self.loops_in_order)
-
-    def __str__(self):
-        return str(self.loops_in_order)
-
-    def __repr__(self):
-        return str(self)
+"""Course representation of a section of knitting with no parent loops.
+
+This module contains the Course class which represents a horizontal row of loops in a knitting pattern.
+"""
+from __future__ import annotations
+
+from typing import Iterator, cast
+
+from knit_graphs._base_classes import _Base_Knit_Graph
+from knit_graphs.Loop import Loop
+
+
+class Course:
+    """Course object for organizing loops into knitting rows.
+
+    A Course represents a horizontal row of loops in a knitting pattern.
+    It maintains an ordered list of loops and provides methods for analyzing the structure and relationships between courses in the knitted fabric.
+    """
+
+    def __init__(self, _knit_graph: _Base_Knit_Graph) -> None:
+        """Initialize an empty course associated with a knit graph.
+
+        Args:
+            _knit_graph (Knit_Graph): The knit graph that this course belongs to.
+        """
+        self.loops_in_order: list[Loop] = []
+        self._loop_set: set[Loop] = set()
+
+    def add_loop(self, loop: Loop, index: int | None = None) -> None:
+        """Add a loop to the course at the specified index or at the end.
+
+        Args:
+            loop (Loop): The loop to add to this course.
+            index (int | None, optional): The index position to insert the loop at. If None, appends to the end.
+        """
+        for parent_loop in loop.parent_loops:
+            assert parent_loop not in self, f"{loop} has parent {parent_loop}, cannot be added to same course"
+        self._loop_set.add(loop)
+        if index is None:
+            self.loops_in_order.append(loop)
+        else:
+            self.loops_in_order.insert(index, loop)
+
+    def has_increase(self) -> bool:
+        """Check if this course contains any yarn overs that start new wales.
+
+        Returns:
+            bool: True if the course has at least one yarn over (loop with no parent loops) to start new wales.
+        """
+        return any(not loop.has_parent_loops() for loop in self)
+
+    def has_decrease(self) -> bool:
+        """Check if this course contains any decrease stitches that merge wales.
+
+        Returns:
+            bool: True if the course has at least one decrease stitch (loop with multiple parent loops) merging two or more wales.
+        """
+        return any(len(loop.parent_loops) > 1 for loop in self)
+
+    def __getitem__(self, index: int | slice) -> Loop | list[Loop]:
+        """Get loop(s) at the specified index or slice.
+
+        Args:
+            index (int | slice): The index or slice to retrieve from the course.
+
+        Returns:
+            Loop | list[Loop]: The loop at the specified index, or list of loops for a slice.
+        """
+        return self.loops_in_order[index]
+
+    def in_round_with(self, next_course: Course) -> bool:
+        """Check if the next course connects to this course in a circular pattern.
+
+        This method determines if the courses are connected in the round (circular knitting) by checking if the next course starts at the beginning of this course.
+
+        Args:
+            next_course (Course): The course that should follow this course in circular knitting.
+
+        Returns:
+            bool: True if the next course starts at the beginning of this course, indicating circular knitting.
+        """
+        next_start: Loop = cast(Loop, next_course[0])
+        i = 1
+        while not next_start.has_parent_loops():
+            next_start = cast(Loop, next_course[i])
+            i += 1
+        return self[0] in next_start.parent_loops
+
+    def in_row_with(self, next_course: Course) -> bool:
+        """Check if the next course connects to this course in a flat/row pattern.
+
+        This method determines if the courses are connected in flat knitting (back and forth) by checking if the next course starts at the end of this course.
+
+        Args:
+            next_course (Course): The course that should follow this course in flat knitting.
+
+        Returns:
+            bool: True if the next course starts at the end of this course, indicating flat/row knitting.
+        """
+        next_start: Loop = cast(Loop, next_course[0])
+        i = 1
+        while not next_start.has_parent_loops():
+            next_start = cast(Loop, next_course[i])
+            i += 1
+        return self[-1] in next_start.parent_loops
+
+    def __contains__(self, loop: Loop) -> bool:
+        """Check if a loop is contained in this course.
+
+        Args:
+            loop (Loop): The loop to check for membership in this course.
+
+        Returns:
+            bool: True if the loop is in this course, False otherwise.
+        """
+        return loop in self._loop_set
+
+    def __iter__(self) -> Iterator[Loop]:
+        """Iterate over loops in this course in order.
+
+        Returns:
+            Iterator[Loop]: An iterator over the loops in this course in their natural order.
+        """
+        return iter(self.loops_in_order)
+
+    def __reversed__(self) -> Iterator[Loop]:
+        """Iterate over loops in this course in reverse order.
+
+        Returns:
+            Iterator[Loop]: An iterator over the loops in this course in reverse order.
+        """
+        return reversed(self.loops_in_order)
+
+    def __len__(self) -> int:
+        """Get the number of loops in this course.
+
+        Returns:
+            int: The total number of loops in this course.
+        """
+        return len(self.loops_in_order)
+
+    def __str__(self) -> str:
+        """Get string representation of this course.
+
+        Returns:
+            str: String representation showing the ordered list of loops.
+        """
+        return str(self.loops_in_order)
+
+    def __repr__(self) -> str:
+        """Get string representation of this course for debugging.
+
+        Returns:
+            str: String representation showing the ordered list of loops.
+        """
+        return str(self)