TurtleExtension 1.0.0__tar.gz → 2.0.0__tar.gz

{turtleextension-1.0.0 → turtleextension-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TurtleExtension
-Version: 1.0.0
+Version: 2.0.0
 Summary: A Python utility library providing turtle extensions on top of Python's original turtle feature.
 Author-email: "Miah M. Sabiq" <miah.sabiq@gibs.at>
 Requires-Python: >=3.14
@@ -30,7 +30,7 @@ TurtleExtension is a Python project dedicated to extending and experimenting wit
 Once published to PyPI, install with:
 
 ```bash
-python -m pip install TurtleExtension
+python -m pip install turtle_extension
 ```
 
 ## Usage
@@ -38,7 +38,7 @@ python -m pip install TurtleExtension
 ```python
 import turtle
 
-# Your TurtleExtension functionality goes here.
+# Your turtle_extension functionality goes here.
 ```
 
 The public API and usage examples will be documented as the project develops.
@@ -49,7 +49,7 @@ Clone the repository:
 
 ```bash
 git clone https://github.com/YOUR-USERNAME/TurtleExtension.git
-cd TurtleExtension
+cd turtle_extension
 ```
 
 Install the package locally if your project contains a `pyproject.toml`:

{turtleextension-1.0.0 → turtleextension-2.0.0}/README.md

@@ -19,7 +19,7 @@ TurtleExtension is a Python project dedicated to extending and experimenting wit
 Once published to PyPI, install with:
 
 ```bash
-python -m pip install TurtleExtension
+python -m pip install turtle_extension
 ```
 
 ## Usage
@@ -27,7 +27,7 @@ python -m pip install TurtleExtension
 ```python
 import turtle
 
-# Your TurtleExtension functionality goes here.
+# Your turtle_extension functionality goes here.
 ```
 
 The public API and usage examples will be documented as the project develops.
@@ -38,7 +38,7 @@ Clone the repository:
 
 ```bash
 git clone https://github.com/YOUR-USERNAME/TurtleExtension.git
-cd TurtleExtension
+cd turtle_extension
 ```
 
 Install the package locally if your project contains a `pyproject.toml`:

{turtleextension-1.0.0 → turtleextension-2.0.0}/TurtleExtension.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TurtleExtension
-Version: 1.0.0
+Version: 2.0.0
 Summary: A Python utility library providing turtle extensions on top of Python's original turtle feature.
 Author-email: "Miah M. Sabiq" <miah.sabiq@gibs.at>
 Requires-Python: >=3.14
@@ -30,7 +30,7 @@ TurtleExtension is a Python project dedicated to extending and experimenting wit
 Once published to PyPI, install with:
 
 ```bash
-python -m pip install TurtleExtension
+python -m pip install turtle_extension
 ```
 
 ## Usage
@@ -38,7 +38,7 @@ python -m pip install TurtleExtension
 ```python
 import turtle
 
-# Your TurtleExtension functionality goes here.
+# Your turtle_extension functionality goes here.
 ```
 
 The public API and usage examples will be documented as the project develops.
@@ -49,7 +49,7 @@ Clone the repository:
 
 ```bash
 git clone https://github.com/YOUR-USERNAME/TurtleExtension.git
-cd TurtleExtension
+cd turtle_extension
 ```
 
 Install the package locally if your project contains a `pyproject.toml`:

turtleextension-2.0.0/TurtleExtension.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+LICENSE
+README.md
+pyproject.toml
+TurtleExtension.egg-info/PKG-INFO
+TurtleExtension.egg-info/SOURCES.txt
+TurtleExtension.egg-info/dependency_links.txt
+TurtleExtension.egg-info/requires.txt
+TurtleExtension.egg-info/top_level.txt
+turtle_extension/__init__.py
+turtle_extension/foundations/__init__.py
+turtle_extension/foundations/custom_turtle_shapes.py
+turtle_extension/foundations/custom_turtle_shapes.pyi
+turtle_extension/foundations/global_functions.py
+turtle_extension/foundations/global_functions.pyi
+turtle_extension/foundations/global_variables.py
+turtle_extension/foundations/global_variables.pyi
+turtle_extension/foundations/turtle_functions.py
+turtle_extension/foundations/turtle_functions.pyi
+turtle_extension/turtle_heart/__init__.py
+turtle_extension/turtle_heart/turtle_skeleton.py
+turtle_extension/turtle_heart/turtle_skeleton.pyi

turtleextension-2.0.0/TurtleExtension.egg-info/top_level.txt

@@ -0,0 +1 @@
+turtle_extension

{turtleextension-1.0.0 → turtleextension-2.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "TurtleExtension"
-version = "1.0.0"
+version = "2.0.0"
 description = "A Python utility library providing turtle extensions on top of Python's original turtle feature."
 readme = "README.md"
 requires-python = ">= 3.14"
@@ -19,5 +19,10 @@ authors = [
 
 [tool.setuptools.packages.find]
 include = [
-    "TurtleExtension*",
+    "turtle_extension*",
+]
+
+[tool.ruff.lint]
+ignore = [
+    "RUF022",
 ]

{turtleextension-1.0.0/TurtleExtension → turtleextension-2.0.0/turtle_extension}/__init__.py

@@ -12,27 +12,23 @@ And a lot more.
 Author: Miah M. Sabiq
 """
 
-from .Foundations import (
+from .foundations import (
+   CUSTOM_SHAPES,
+   SU,
    UV,
-   t_now,
-   t_shape,
-
+   TurtleFct,
+   UserShape,
    get_screen,
-   SU,
+   get_UserShape_dict,
    mainloop,
-   tls_color,
    reset_tls,
-
-   UserShape,
-   get_UserShape_dict,
-   CUSTOM_SHAPES,
-
-   TurtleFct,
+   t_now,
+   t_shape,
+   tls_color,
 )
-
-from .TurtleHeart import (
-ChainTurtle,
-tl,
+from .turtle_heart import (
+   ChainTurtle,
+   tl,
 )
 
 __all__ = [

{turtleextension-1.0.0/TurtleExtension/Foundations → turtleextension-2.0.0/turtle_extension/foundations}/__init__.py

@@ -1,25 +1,22 @@
-from .GlobalVariables import (
-    UV,
-    t_now,
-    t_shape,
+from .custom_turtle_shapes import (
+    CUSTOM_SHAPES,
+    UserShape,
+    get_UserShape_dict,
 )
-
-from .GlobalFunctions import (
-    get_screen,
+from .global_functions import (
     SU,
+    get_screen,
     mainloop,
-    tls_color,
     reset_tls,
+    tls_color,
 )
-
-from .CustomTurtleShapes import (
-    UserShape,
-    get_UserShape_dict,
-    CUSTOM_SHAPES,
+from .global_variables import (
+    UV,
+    t_now,
+    t_shape,
 )
-
-from .TurtleFunctions import (
-TurtleFct,
+from .turtle_functions import (
+    TurtleFct,
 )
 
 __all__ = [

turtleextension-1.0.0/TurtleExtension/Foundations/CustomTurtleShapes.py → turtleextension-2.0.0/turtle_extension/foundations/custom_turtle_shapes.py

@@ -1,7 +1,8 @@
-from ..TurtleHeart import tl
 from numbers import Real
-import UF as uf
 
+import uf
+
+from ..turtle_heart import tl
 
 helper = uf.helper
 

turtleextension-1.0.0/TurtleExtension/Foundations/CustomTurtleShapes.pyi → turtleextension-2.0.0/turtle_extension/foundations/custom_turtle_shapes.pyi

@@ -2,70 +2,67 @@
 This module contains the class Usershape which contains functions to make a customized turtle shape.
 """
 
-from numbers import Real
 from collections.abc import Callable, Sequence
+from numbers import Real
+
+type ReturnShapeType = Sequence[tuple[Real,Real]] | None
 
+type UserShapeDictType = dict[
+    str,
+    Callable[[], ReturnShapeType]
+]
 
-type return_shape = Sequence[tuple[Real,Real]] | None
-type user_shape_dict = dict[str, Callable[[], return_shape]]
 
 class UserShape:
     """
     This class contains different custom turtle shape maker functions
     """
     @staticmethod
-    def custom_circle() -> return_shape:
+    def custom_circle() -> ReturnShapeType:
         """
         Creates a custom circle turtle shape.
         :return: the custom shape
         """
-        ...
 
     @staticmethod
-    def custom_square() -> return_shape:
+    def custom_square() -> ReturnShapeType:
         """
         Creates a custom square turtle shape.
         :return: the custom shape
         """
-        ...
 
     @staticmethod
-    def custom_triangle() -> return_shape:
+    def custom_triangle() -> ReturnShapeType:
         """
         Creates a custom equilateral triangle turtle shape.
         :return: the custom shape
         """
-        ...
 
     @staticmethod
-    def custom_poly() -> return_shape:
+    def custom_poly() -> ReturnShapeType:
         """
         Creates a custom regular polygon turtle shape.
         :return: the custom shape
         """
-        ...
 
     @staticmethod
-    def custom_SOD() -> return_shape:
+    def custom_SOD() -> ReturnShapeType:
         """
         Creates a custom star of David turtle shape.
         :return: the custom shape
         """
-        ...
 
     @classmethod
-    def _list_shapes(cls) -> user_shape_dict:
+    def _list_shapes(cls) -> UserShapeDictType:
         """
         Creates a dictionary with the functions in UserShape and returns it
         :return: dictionary containing function names -> function
         """
-        ...
 
-def get_UserShape_dict() -> user_shape_dict:
+def get_UserShape_dict() -> UserShapeDictType:
     """
     Takes all custom turtle functions in UserShape and returns a dictionary with them
     :return: dictionary mapping function names to functions
     """
-    ...
 
-CUSTOM_SHAPES: user_shape_dict
+CUSTOM_SHAPES: UserShapeDictType

turtleextension-1.0.0/TurtleExtension/Foundations/GlobalFunctions.py → turtleextension-2.0.0/turtle_extension/foundations/global_functions.py

@@ -1,10 +1,11 @@
-from ..TurtleHeart import tl, ChainTurtle
-from .GlobalVariables import t_shape, UV
-from turtle import TurtleGraphicsError
 from time import sleep as rest
-import UF as uf
-from typing import Final, Literal
+from turtle import TurtleGraphicsError
+from typing import Final
 
+import uf
+
+from ..turtle_heart import ChainTurtle, tl
+from .global_variables import UV, t_shape
 
 _screen = None
 
@@ -24,13 +25,12 @@ def SU():
 def mainloop():
     get_screen().mainloop()
 
-type turtle_list = list[ChainTurtle]
 
 def tls_color(**options):
 
-    tl_num_name: Final[Literal["tl_num"]] = "tl_num"
-    entry_name: Final[Literal["entry"]] = "entry"
-    index_name: Final[Literal["index"]] = "index"
+    tl_num_name: Final = "tl_num"
+    entry_name: Final = "entry"
+    index_name: Final = "index"
 
     if tl_num_name in options:
         tl_num = options[tl_num_name]
@@ -51,7 +51,8 @@ def tls_color(**options):
     else:
         print("NONE of the entered options exist!")
         return None
-    tls: turtle_list = []
+
+    tls: list[ChainTurtle] = []
 
     for color_num in range(turtles_num_count):
         while True:
@@ -80,7 +81,7 @@ def tls_color(**options):
 
 def reset_tls(tls_list):
 
-    tls_list_name: Final[Literal["tls_list"]] = "tls_list"
+    tls_list_name: Final = "tls_list"
     uf.TypeValidate(list)(tls_list, name=tls_list_name)
     uf.SequenceValidate(ChainTurtle, ...)(tls_list, name=tls_list_name)
 

turtleextension-1.0.0/TurtleExtension/Foundations/GlobalFunctions.pyi → turtleextension-2.0.0/turtle_extension/foundations/global_functions.pyi

@@ -3,33 +3,29 @@ This module contains a very useful function: tls_color, which lets the user crea
 colors and get a list with them.
 """
 
-from ..TurtleHeart import tl, ChainTurtle
-
+from ..turtle_heart import ChainTurtle, tl
 
 def get_screen() -> tl.Screen:
     """
     Initiates the turtle screen when the function is called.
     :return: turtle screen object
     """
-    ...
 
 def SU() -> None:
     """
     This function updates the turtle screen.
     :return: None
     """
-    ...
 
 def mainloop() -> None:
     """
     This function keeps the turtle screen open.
     :return: None
     """
-    ...
 
-type turtle_list = list[ChainTurtle]
+type TurtleListType = list[ChainTurtle]
 
-def tls_color(**options) -> int | tuple[turtle_list, int] | turtle_list | None:
+def tls_color(**options) -> int | tuple[TurtleListType, int] | TurtleListType | None:
     """This function creates a turtle list with their colors or adds newly creates turtles to the UV["tls"] list
     to be used for the user_drawing_ft()
 
@@ -39,9 +35,8 @@ def tls_color(**options) -> int | tuple[turtle_list, int] | turtle_list | None:
     & it returns the index of the last turtle
     :return: tls_num: turtle list with colored turtles, entry: list with colored turtles + number of turtles ,otherwise: index of last turtle
     """
-    ...
 
-def reset_tls(tls_list: turtle_list) -> list:
+def reset_tls(tls_list: TurtleListType) -> list:
     """
     This function deletes the drawings of given turtle list + turtles
 

turtleextension-1.0.0/TurtleExtension/Foundations/GlobalVariables.pyi → turtleextension-2.0.0/turtle_extension/foundations/global_variables.pyi

@@ -9,8 +9,8 @@ t_shape() -> lets users take the current turtle shape
 """
 
 from typing import Any
-from ..TurtleHeart import ChainTurtle
 
+from ..turtle_heart import ChainTurtle
 
 UV: dict[str, Any]
 
@@ -25,7 +25,6 @@ def t_now() -> ChainTurtle:
 
     :return: ChainTurtle
     """
-    ...
 
 def t_shape() -> str:
     """
@@ -37,4 +36,3 @@ def t_shape() -> str:
 
     :return: string
     """
-    ...

turtleextension-1.0.0/TurtleExtension/Foundations/TurtleFunctions.py → turtleextension-2.0.0/turtle_extension/foundations/turtle_functions.py

@@ -1,7 +1,8 @@
-from ..TurtleHeart import tl, ChainTurtle
-from .GlobalVariables import UV
-from .CustomTurtleShapes import CUSTOM_SHAPES
-import UF as uf
+import uf
+
+from ..turtle_heart import ChainTurtle, tl
+from .custom_turtle_shapes import CUSTOM_SHAPES
+from .global_variables import UV
 
 
 class TurtleFct:

turtleextension-1.0.0/TurtleExtension/Foundations/TurtleFunctions.pyi → turtleextension-2.0.0/turtle_extension/foundations/turtle_functions.pyi

@@ -2,8 +2,7 @@
 This module contains the class TurtleFct which lets the user change the turtle shape to a customized one.
 """
 
-from ..TurtleHeart import ChainTurtle
-
+from ..turtle_heart import ChainTurtle
 
 class TurtleFct:
     """
@@ -16,7 +15,6 @@ class TurtleFct:
         :param tls_num: ChainTurtle() or None
         :return: ChainTurtle() if tls_num is a ChainTurtle(), otherwise None
         """
-        ...
 
     @staticmethod
     def user_tls_shape_ft(tls_num: ChainTurtle | None = None) -> ChainTurtle | str:
@@ -25,4 +23,3 @@ class TurtleFct:
         :param tls_num: ChainTurtle() or None
         :return: ChainTurtle() if tls_num is a ChainTurtle(), otherwise None
         """
-        ...

turtleextension-2.0.0/turtle_extension/turtle_heart/__init__.py

@@ -0,0 +1,6 @@
+from .turtle_skeleton import ChainTurtle, tl
+
+__all__ = [
+    "ChainTurtle",
+    "tl",
+]

turtleextension-1.0.0/TurtleExtension/TurtleHeart/TurtleSkeleton.py → turtleextension-2.0.0/turtle_extension/turtle_heart/turtle_skeleton.py

@@ -1,5 +1,6 @@
 import turtle as tl
-import UF as uf
+
+import uf
 
 
 class ChainTurtle(tl.Turtle):

turtleextension-1.0.0/TurtleExtension/TurtleHeart/TurtleSkeleton.pyi → turtleextension-2.0.0/turtle_extension/turtle_heart/turtle_skeleton.pyi

@@ -2,11 +2,8 @@
 This module contains the class ChainTurtle() which is the foundational object around which this entire software has been made.
 """
 
-from numbers import Real
 from collections.abc import Callable
-
-
-tl = tl
+from numbers import Real
 
 class ChainTurtle:
     """This class adds chaining functionality to turtle.Turtle"""
@@ -16,7 +13,6 @@ class ChainTurtle:
         :param distance: distance in pixels
         :return: ChainTurtle()
         """
-        ...
 
     def fd_inv(self, distance: Real) -> ChainTurtle:
         """
@@ -24,7 +20,6 @@ class ChainTurtle:
         :param distance: distance in pixels
         :return: ChainTurtle()
         """
-        ...
 
     def bk(self, distance: Real) -> ChainTurtle:
         """
@@ -32,7 +27,6 @@ class ChainTurtle:
         :param distance: distance in pixels
         :return: ChainTurtle()
         """
-        ...
 
     def bk_inv(self, distance: Real) -> ChainTurtle:
         """
@@ -40,7 +34,6 @@ class ChainTurtle:
         :param distance: distance in pixels
         :return: ChainTurtle()
         """
-        ...
 
     def rt(self, angle: Real) -> ChainTurtle:
         """
@@ -48,7 +41,6 @@ class ChainTurtle:
         :param angle: angle in degrees
         :return: ChainTurtle()
         """
-        ...
 
     def lt(self, angle: Real) -> ChainTurtle:
         """
@@ -56,7 +48,6 @@ class ChainTurtle:
         :param angle: angle in degrees
         :return: ChainTurtle()
         """
-        ...
 
     def setpos(self, x_val: Real, y_val: Real) -> ChainTurtle:
         """
@@ -65,61 +56,53 @@ class ChainTurtle:
         :param y_val: y position in pixels
         :return: ChainTurtle()
         """
-        ...
 
     def pu(self) -> ChainTurtle:
         """
         Puts the pen down to leave a trace.
         :return: ChainTurtle()
         """
-        ...
 
     def pd(self) -> ChainTurtle:
         """
         Puts the pen up to not leave a trace.
         :return: ChainTurtle()
         """
-        ...
 
     def seth(self, direction: Real) -> ChainTurtle:
         """
         Sets the direction of the turtle starting East, going counterclockwise.
         :param direction: direction in degrees
         """
-        ...
 
     def home(self) -> ChainTurtle:
         """
         Sets the position of the turtle to home (0, 0) with trace, heading = 0 .
         :return: ChainTurtle()
         """
-        ...
 
     def home_inv(self) -> ChainTurtle:
         """
         Sets the position of the turtle to home (0, 0) without trace, heading = 0 .
         :return: ChainTurtle()
         """
-        ...
 
     def begin_fill(self) -> ChainTurtle:
         """
         Makes the turtle begin fill for a closed shape.
         :return: ChainTurtle()
         """
-        ...
 
     def end_fill(self) -> ChainTurtle:
         """
         Ends the turtle fill for a closed shape, therefore fills the shapes.
         :return: ChainTurtle()
         """
-        ...
 
     def circle(self,
                radius: Real,
                extent: Real | None = None,
-               steps: int = None) -> ChainTurtle:
+               steps: int | None = None) -> ChainTurtle:
         """
         Makes the turtle draw a circle
         :param radius: radius in pixels
@@ -127,33 +110,29 @@ class ChainTurtle:
         :param steps: number of sides
         :return: ChainTurtle()
         """
-        ...
 
     def circle_fill(self,
                     radius: Real,
                     angle: Real | None = None,
-                    sides: int = None) -> ChainTurtle:
+                    sides: int | None = None) -> ChainTurtle:
         """
         Makes the turtle draw a circle and fills it
         :param radius: radius in degrees
         :param angle: angle in degrees
         :param sides: number of sides
         """
-        ...
 
     def dot(self, radius: Real) -> ChainTurtle:
         """
         Makes the turtle draw a colored dot
         :param radius: radius in pixels
         """
-        ...
 
     def color(self, turtle_color: str) -> ChainTurtle:
         """
         Lets the user change the color of the turtle trace and turtle color itself
         :param turtle_color: valid turtle color
         """
-        ...
 
     def teleport(self, x: Real, y: Real, *, fill_gap: bool = False) -> ChainTurtle:
         """
@@ -161,35 +140,30 @@ class ChainTurtle:
         :param x: x position in pixels
         :param y: y position in pixels
         """
-        ...
 
     def shape(self, shape_name: str) -> ChainTurtle:
         """
         Changes the shape of the turtle shape
         :param shape_name: name of the shape
         """
-        ...
 
     def undo(self) -> ChainTurtle:
         """
         Undoes the last turtle command.
         :return: ChainTurtle()
         """
-        ...
 
     def clear(self) -> ChainTurtle:
         """
         Deletes the turtles drawings.
         :return: ChainTurtle()
         """
-        ...
 
     def ht(self) -> ChainTurtle:
         """
         Hides the turtle.
         :return: ChainTurtle()
         """
-        ...
 
     @classmethod
     def list_methods(cls) -> dict[str, Callable]:
@@ -197,4 +171,3 @@ class ChainTurtle:
         Creates a dictionary with all ChainTurtle methods and returns it
         :return: dictionary
         """
-        ...

turtleextension-1.0.0/TurtleExtension/TurtleHeart/__init__.py

@@ -1,6 +0,0 @@
-from .TurtleSkeleton import ChainTurtle, tl
-
-__all__ = [
-    "ChainTurtle",
-    "tl",
-]

turtleextension-1.0.0/TurtleExtension.egg-info/SOURCES.txt

@@ -1,21 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-TurtleExtension/__init__.py
-TurtleExtension.egg-info/PKG-INFO
-TurtleExtension.egg-info/SOURCES.txt
-TurtleExtension.egg-info/dependency_links.txt
-TurtleExtension.egg-info/requires.txt
-TurtleExtension.egg-info/top_level.txt
-TurtleExtension/Foundations/CustomTurtleShapes.py
-TurtleExtension/Foundations/CustomTurtleShapes.pyi
-TurtleExtension/Foundations/GlobalFunctions.py
-TurtleExtension/Foundations/GlobalFunctions.pyi
-TurtleExtension/Foundations/GlobalVariables.py
-TurtleExtension/Foundations/GlobalVariables.pyi
-TurtleExtension/Foundations/TurtleFunctions.py
-TurtleExtension/Foundations/TurtleFunctions.pyi
-TurtleExtension/Foundations/__init__.py
-TurtleExtension/TurtleHeart/TurtleSkeleton.py
-TurtleExtension/TurtleHeart/TurtleSkeleton.pyi
-TurtleExtension/TurtleHeart/__init__.py

turtleextension-1.0.0/TurtleExtension.egg-info/top_level.txt

@@ -1 +0,0 @@
-TurtleExtension