knit-graphs 0.0.10__tar.gz → 0.0.12__tar.gz

{knit_graphs-0.0.10 → knit_graphs-0.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: knit-graphs
-Version: 0.0.10
+Version: 0.0.12
 Summary: A graph representation of knitted structures where each loop is a node and edges represent yarn and stitch relationships.
 Home-page: https://mhofmann-khoury.github.io/knit_graph/
 License: MIT
@@ -20,8 +20,9 @@ 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: networkx (>=3.5)
-Requires-Dist: plotly (>=6.3.0,<7.0.0)
+Requires-Dist: plotly (>=6.3.0)
 Project-URL: Documentation, https://mhofmann-khoury.github.io/knit_graph/
 Project-URL: Repository, https://github.com/mhofmann-Khoury/knit_graph/
 Description-Content-Type: text/markdown

{knit_graphs-0.0.10 → knit_graphs-0.0.12}/docs/source/conf.py

@@ -1,11 +1,11 @@
 """
-    Configuration file for the Sphinx documentation builder.
-    =============================================================================
-    SPHINX DOCUMENTATION CONFIGURATION
-    =============================================================================
-    This file configures how Sphinx generates documentation from your Python code.
-    For the full list of built-in configuration values, see:
-    https://www.sphinx-doc.org/en/master/usage/configuration.html
+Configuration file for the Sphinx documentation builder.
+=============================================================================
+SPHINX DOCUMENTATION CONFIGURATION
+=============================================================================
+This file configures how Sphinx generates documentation from your Python code.
+For the full list of built-in configuration values, see:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
 """
 
 import os
@@ -19,17 +19,17 @@ from importlib.metadata import PackageNotFoundError, version
 # Add the project root and source directory to Python path so Sphinx can import your modules
 
 # Path to your source code (adjust if not using src/ layout)
-sys.path.insert(0, os.path.abspath('..'))  # Project root
-sys.path.insert(0, os.path.abspath('../src'))  # Source directory
-sys.path.insert(0, os.path.abspath('.'))  # Docs directory
+sys.path.insert(0, os.path.abspath(".."))  # Project root
+sys.path.insert(0, os.path.abspath("../src"))  # Source directory
+sys.path.insert(0, os.path.abspath("."))  # Docs directory
 
 # =============================================================================
 # PROJECT INFORMATION
 # =============================================================================
 
-project = 'knit-graphs'
-copyright = f'{datetime.now().year}, Megan Hofmann'
-author = 'Megan Hofmann'
+project = "knit-graphs"
+copyright = f"{datetime.now().year}, Megan Hofmann"
+author = "Megan Hofmann"
 
 try:
     # Get version from installed package metadata
@@ -49,19 +49,17 @@ release = version
 # Extensions to enable (these add functionality to Sphinx)
 extensions = [
     # Core Sphinx extensions
-    'sphinx.ext.autodoc',  # Generate docs from docstrings
-    'sphinx.ext.autosummary',  # Generate summary tables automatically
-    'sphinx.ext.viewcode',  # Add [source] links to documentation
-    'sphinx.ext.napoleon',  # Support Google/NumPy docstring styles
-    'sphinx.ext.intersphinx',  # Link to other project docs (e.g., Python docs)
-    'sphinx.ext.githubpages',  # Publish to GitHub Pages (.nojekyll file)
-    'sphinx.ext.todo',  # Support TODO items in docs
-    'sphinx.ext.coverage',  # Check documentation coverage
-    'sphinx.ext.doctest',  # Test code snippets in documentation
-
+    "sphinx.ext.autodoc",  # Generate docs from docstrings
+    "sphinx.ext.autosummary",  # Generate summary tables automatically
+    "sphinx.ext.viewcode",  # Add [source] links to documentation
+    "sphinx.ext.napoleon",  # Support Google/NumPy docstring styles
+    "sphinx.ext.intersphinx",  # Link to other project docs (e.g., Python docs)
+    "sphinx.ext.githubpages",  # Publish to GitHub Pages (.nojekyll file)
+    "sphinx.ext.todo",  # Support TODO items in docs
+    "sphinx.ext.coverage",  # Check documentation coverage
+    "sphinx.ext.doctest",  # Test code snippets in documentation
     # Third-party extensions (these need to be installed)
-    'sphinx_autodoc_typehints',  # Better type hint rendering
-    'myst_parser',  # Support for Markdown files (optional)
+    "myst_parser",  # Support for Markdown files (optional)
 ]
 
 # =============================================================================
@@ -70,19 +68,19 @@ extensions = [
 
 # File extensions that Sphinx will process
 source_suffix = {
-    '.rst': None,  # RestructuredText (default)
-    '.md': 'myst_parser',  # Markdown (requires myst_parser extension)
+    ".rst": None,  # RestructuredText (default)
+    ".md": "myst_parser",  # Markdown (requires myst_parser extension)
 }
 
 # The master toctree document (main page)
-master_doc = 'index'
+master_doc = "index"
 
 # Files and directories to exclude from processing
 exclude_patterns = [
-    '_build',  # Build output directory
-    'Thumbs.db',  # Windows thumbnail cache
-    '.DS_Store',  # macOS metadata
-    '**.ipynb_checkpoints',  # Jupyter notebook checkpoints
+    "_build",  # Build output directory
+    "Thumbs.db",  # Windows thumbnail cache
+    ".DS_Store",  # macOS metadata
+    "**.ipynb_checkpoints",  # Jupyter notebook checkpoints
 ]
 
 # =============================================================================
@@ -90,31 +88,29 @@ exclude_patterns = [
 # =============================================================================
 
 # The theme to use for HTML pages
-html_theme = 'sphinx_rtd_theme'  # Read the Docs theme (clean, professional)
+html_theme = "sphinx_rtd_theme"  # Read the Docs theme (clean, professional)
 
 # Directories containing static files (CSS, JS, images)
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # Theme-specific options
 html_theme_options = {
-    'logo_only': False,  # Show project name with logo
-    'display_version': True,  # Show version in sidebar
-    'prev_next_buttons_location': 'bottom',  # Navigation button placement
-    'style_external_links': True,  # Style external links differently
-    'vcs_pageview_mode': '',  # Version control integration
-    'style_nav_header_background': '#2980B9',  # Header background color
-
+    "logo_only": False,  # Show project name with logo
+    "prev_next_buttons_location": "bottom",  # Navigation button placement
+    "style_external_links": True,  # Style external links differently
+    "vcs_pageview_mode": "",  # Version control integration
+    "style_nav_header_background": "#2980B9",  # Header background color
     # Table of contents options
-    'collapse_navigation': True,  # Collapse subsections in nav
-    'sticky_navigation': True,  # Keep navigation visible on scroll
-    'navigation_depth': 4,  # Maximum navigation depth
-    'includehidden': True,  # Include hidden toctrees
-    'titles_only': False,  # Show subsection titles in nav
+    "collapse_navigation": True,  # Collapse subsections in nav
+    "sticky_navigation": True,  # Keep navigation visible on scroll
+    "navigation_depth": 4,  # Maximum navigation depth
+    "includehidden": True,  # Include hidden toctrees
+    "titles_only": False,  # Show subsection titles in nav
 }
 
 # Additional HTML options
-html_title = f'{project} Documentation'  # Browser window title
+html_title = f"{project} Documentation"  # Browser window title
 html_short_title = project  # Short title for navigation
 
 
@@ -136,20 +132,20 @@ html_short_title = project  # Short title for navigation
 
 # Default options for all autodoc directives
 autodoc_default_options = {
-    'members': True,  # Include all members
-    'member-order': 'bysource',  # Order members as they appear in source
-    'special-members': '__init__',  # Include __init__ methods
-    'undoc-members': True,  # Include members without docstrings
-    'exclude-members': '__weakref__',  # Exclude certain members
-    'show-inheritance': True,  # Show class inheritance
-    'inherited-members': True,  # Include inherited methods
+    "members": True,  # Include all members
+    "member-order": "bysource",  # Order members as they appear in source
+    "special-members": "__init__",  # Include __init__ methods
+    "undoc-members": True,  # Include members without docstrings
+    "exclude-members": "__weakref__",  # Exclude certain members
+    "show-inheritance": True,  # Show class inheritance
+    "inherited-members": True,  # Include inherited methods
 }
 
 # How to display class signatures
 autodoc_class_signature = "mixed"  # Show __init__ parameters with class
 
 # Order of members in documentation
-autodoc_member_order = 'bysource'  # bysource, alphabetical, or groupwise
+autodoc_member_order = "bysource"  # bysource, alphabetical, or groupwise
 
 # Mock imports for modules that might not be available during doc building
 # Add any modules that cause import errors during doc building
@@ -159,6 +155,10 @@ autodoc_mock_imports = [
     # 'some_optional_dependency',
 ]
 
+# Enable type hints in signatures
+autodoc_typehints = "signature"  # Show type hints in function signatures
+autodoc_typehints_description_target = "documented"  # Where to show type info
+
 # =============================================================================
 # AUTOSUMMARY CONFIGURATION
 # =============================================================================
@@ -193,13 +193,13 @@ napoleon_attr_annotations = True  # Include attribute annotations
 # Links to external documentation
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'numpy': ('https://numpy.org/doc/stable/', None),
-    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
-    'matplotlib': ('https://matplotlib.org/stable/', None),
-    'scipy': ('https://docs.scipy.org/doc/scipy/', None),
-    'sklearn': ('https://scikit-learn.org/stable/', None),
-    'typing': ('https://typing.readthedocs.io/en/latest/', None),
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
+    "matplotlib": ("https://matplotlib.org/stable/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
+    "sklearn": ("https://scikit-learn.org/stable/", None),
+    "typing": ("https://typing.readthedocs.io/en/latest/", None),
 }
 
 # =============================================================================
@@ -207,10 +207,8 @@ intersphinx_mapping = {
 # =============================================================================
 # Controls how type hints are displayed in documentation
 
-typehints_fully_qualified = False  # Use short names for types
+# Note: These settings work with sphinx.ext.autodoc built-in type hint support
 always_document_param_types = True  # Always show parameter types
-typehints_document_rtype = True  # Document return types
-typehints_use_rtype = True  # Use :rtype: directive for return types
 
 # =============================================================================
 # TODO EXTENSION CONFIGURATION
@@ -245,16 +243,17 @@ add_module_names = False  # Don't prepend module names to functions
 show_authors = False  # Don't show author info by default
 
 # Syntax highlighting style
-pygments_style = 'sphinx'  # Code highlighting theme
+pygments_style = "sphinx"  # Code highlighting theme
 
 # Language for content that doesn't specify a language
-language = 'en'
+language = "en"
 
 
 # =============================================================================
 # CUSTOM FUNCTIONS AND SETUP
 # =============================================================================
 
+
 def autodoc_skip_member(app, what, name, obj, skip, options):
     """
     Custom function to control which members are included in documentation.
@@ -288,15 +287,16 @@ def setup(app):
         app: The Sphinx application instance
     """
     # Connect custom functions to Sphinx events
-    app.connect('autodoc-skip-member', autodoc_skip_member)
+    app.connect("autodoc-skip-member", autodoc_skip_member)
 
     # Return extension metadata
     return {
-        'version': version,
-        'parallel_read_safe': True,
-        'parallel_write_safe': True,
+        "version": version,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
     }
 
+
 # =============================================================================
 # CHECKLIST FOR SPHINX SETUP
 # =============================================================================

{knit_graphs-0.0.10 → knit_graphs-0.0.12}/docs/source/index.rst

@@ -3,10 +3,6 @@ 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

knit_graphs-0.0.12/pyproject.toml

@@ -0,0 +1,251 @@
+# =============================================================================
+# POETRY BUILD SYSTEM CONFIGURATION
+# =============================================================================
+# This section tells Poetry how to build your package
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]  # Poetry build backend version
+build-backend = "poetry.core.masonry.api"  # Use Poetry's build system
+
+# =============================================================================
+# PROJECT METADATA AND CONFIGURATION
+# =============================================================================
+# All the information about your project that will appear on PyPI
+[tool.poetry]
+name = "knit-graphs"
+version = "0.0.12"
+description = "A graph representation of knitted structures where each loop is a node and edges represent yarn and stitch relationships."
+authors = ["Megan Hofmann <m.hofmann@northeastern.edu>"]
+maintainers = ["Megan Hofmann <m.hofmann@northeastern.edu>"]
+license = "MIT"                     # License type (shows up on PyPI)
+readme = "README.md"                # File to use as long description on PyPI
+homepage = "https://mhofmann-khoury.github.io/knit_graph/"
+repository = "https://github.com/mhofmann-Khoury/knit_graph/"
+documentation = "https://mhofmann-khoury.github.io/knit_graph/"
+keywords = [
+    "ACT Lab",
+    "Northeastern University",
+    "knit",
+    "machine knit",
+    "fabrication",
+    "textile"]
+classifiers = [                     # PyPI classifiers for categorization
+    "Development Status :: 3 - Alpha",                     # Update as project matures (Alpha -> Beta -> Production/Stable)
+    "Natural Language :: English",                         # Human language
+    "Intended Audience :: Developers",                     # Add other audiences if relevant
+    "License :: OSI Approved :: MIT License",              # Update if using different license
+    "Operating System :: OS Independent",                  # Platform support
+    "Programming Language :: Python :: 3",                # Python support
+    "Programming Language :: Python :: 3.11",             # Update supported Python versions
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",             # Latest Python version
+    "Topic :: Scientific/Engineering",
+    "Typing :: Typed",                                     # Signals type hint support
+]
+
+# =============================================================================
+# PACKAGE STRUCTURE CONFIGURATION
+# =============================================================================
+# Tell Poetry where to find your Python packages in your repository
+packages = [
+    {include = "knit_graphs", from = "src"},
+]
+
+# =============================================================================
+# FILES TO INCLUDE/EXCLUDE IN DISTRIBUTION
+# =============================================================================
+# Include additional files when building the package for distribution
+include = [
+    "README.md",                    # Project description
+    "LICENSE",                      # License file
+    "docs/**/*",                    # All documentation files
+    "src/knit_graphs/py.typed",     # PEP 561 marker for type information
+]
+
+# Exclude files from the distribution package (keeps package size down)
+exclude = [
+    "tests/**/*",                   # Don't include test files in distribution
+    "docs/_build/**/*",             # Don't include built documentation
+    "*.pyc",                        # No compiled Python files
+    "__pycache__/**/*",             # No Python cache directories
+    ".coverage",                    # No coverage data files
+    "htmlcov/**/*",                 # No coverage HTML reports
+    ".git/**/*",                    # No git files
+    ".github/**/*",                 # No GitHub workflow files
+    ".pytest_cache/**/*",           # No pytest cache
+    ".mypy_cache/**/*",             # No MyPy cache
+    "*.egg-info/**/*",              # No build artifacts
+    "dist/**/*",                    # No distribution files
+]
+
+# =============================================================================
+# RUNTIME DEPENDENCIES
+# =============================================================================
+# These are packages your project needs to run in production
+[tool.poetry.dependencies]
+python = ">=3.11,<3.14"
+networkx = ">=3.5"
+plotly = ">=6.3.0"
+
+# =============================================================================
+# DEVELOPMENT DEPENDENCIES
+# =============================================================================
+# These packages are only needed during development and testing
+[tool.poetry.group.dev.dependencies]
+importlib-resources = ">=6.5.2"
+coverage = "^7.3.0"
+black = "^24.10.0"
+ruff = "^0.7.4"
+isort = "^5.13.2"
+mypy = "^1.13.0"
+pre-commit = "^3.8.0"
+twine = "^5.1.0"
+
+# =============================================================================
+# DOCUMENTATION-SPECIFIC DEPENDENCIES
+# =============================================================================
+# Separate dependency group for building documentation (allows selective installation)
+[tool.poetry.group.docs.dependencies]
+sphinx = "^7.4.0"
+sphinx-rtd-theme = "^3.0.0"
+sphinx-autoapi = "^3.4.0"
+myst-parser = "^4.0.0"
+
+# =============================================================================
+# BLACK CODE FORMATTER CONFIGURATION
+# =============================================================================
+[tool.black]
+line-length = 120
+target-version = ["py311"]
+extend-exclude = "tests"
+
+# =============================================================================
+# RUFF LINTER CONFIGURATION
+# =============================================================================
+[tool.ruff]
+line-length = 120
+target-version = "py311"
+
+exclude = [
+    ".git",
+    ".mypy_cache",
+    ".ruff_cache",
+    ".venv",
+    "__pycache__",
+    "build",
+    "dist",
+    "docs",
+    "tests",
+]
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # pyflakes
+    "I",      # isort
+    "N",      # pep8-naming
+    "UP",     # pyupgrade
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "SIM",    # flake8-simplify
+]
+
+ignore = [
+    "E501",   # Line too long (handled by Black)
+    "E741",   # Ambiguous variable name (l, O, I) - allow single-letter loop variables
+    "N801",   # CapWords convention ignored
+    "N999",   # Module name conventions ignored
+    "UP038",  # Use older isinstance tuple syntax for mypy compatibility
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = [
+    "S101",   # Allow assert statements in tests
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+# =============================================================================
+# ISORT IMPORT SORTER CONFIGURATION
+# =============================================================================
+[tool.isort]
+profile = "black"
+line_length = 120
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+known_first_party = ["knit_graphs"]
+skip_glob = ["tests/*"]
+
+# =============================================================================
+# MYPY STATIC TYPE CHECKER CONFIGURATION
+# =============================================================================
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = false
+warn_unreachable = true
+strict_equality = true
+show_error_codes = true
+ignore_missing_imports = true
+allow_redefinition = true
+allow_untyped_globals = true
+implicit_reexport = true
+
+disable_error_code = [
+    "attr-defined",
+    "no-redef",
+]
+
+exclude = [
+    "tests/",
+]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+check_untyped_defs = false
+
+# =============================================================================
+# COVERAGE.PY CONFIGURATION
+# =============================================================================
+[tool.coverage.run]
+source = ["src"]
+omit = [
+    "*/tests/*",
+    "*/test_*",
+    "*/__pycache__/*",
+    "*/site-packages/*",
+    "*/.venv/*",
+]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]
+show_missing = true
+skip_covered = false
+skip_empty = true