ufo-spacing-lib 0.1.0__tar.gz

ufo_spacing_lib-0.1.0/.gitignore

@@ -0,0 +1,49 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+.cursor/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# Type checking
+.mypy_cache/
+
+# Build
+dist/
+*.whl
+PUBLISHING.md
+.claude/

ufo_spacing_lib-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Alexander Lubovenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

ufo_spacing_lib-0.1.0/PKG-INFO

@@ -0,0 +1,299 @@
+Metadata-Version: 2.4
+Name: ufo-spacing-lib
+Version: 0.1.0
+Summary: Font spacing management library for UFO-compatible fonts (kerning, margins, groups)
+Project-URL: Homepage, https://github.com/typedev/ufo-spacing-lib
+Project-URL: Repository, https://github.com/typedev/ufo-spacing-lib
+Project-URL: Documentation, https://github.com/typedev/ufo-spacing-lib#readme
+Project-URL: Issues, https://github.com/typedev/ufo-spacing-lib/issues
+Author-email: Alexander Lubovenko <lubovenko@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: font,fonttools,kerning,spacing,type-design,typography,ufo
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
+Classifier: Topic :: Text Processing :: Fonts
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# UFO Spacing Library
+
+A framework-agnostic Python library for managing font spacing (kerning and margins) with full undo/redo support. Designed to work with UFO-compatible font objects.
+
+## Features
+
+- **Framework Independent**: Works with any font editor that provides compatible font objects
+- **Undo/Redo Support**: Full command pattern implementation with unlimited history
+- **Multi-Font Operations**: Support for linked/interpolated fonts with per-font scaling
+- **Preview/Simulation**: VirtualFont wrapper for testing changes without modifying real font
+- **Composite Propagation**: Automatic margin propagation to composite glyphs
+- **Well Documented**: Comprehensive docstrings and type hints throughout
+
+## Installation
+
+```bash
+# From PyPI (when published)
+pip install ufo-spacing-lib
+
+# From source
+pip install -e .
+
+# Or with uv
+uv pip install -e .
+```
+
+## Quick Start
+
+### Kerning Operations
+
+```python
+from ufo_spacing_lib import (
+    KerningEditor,
+    FontContext,
+    AdjustKerningCommand,
+    SetKerningCommand,
+    RemoveKerningCommand,
+)
+
+# Create an editor
+editor = KerningEditor()
+
+# Create a context for your font
+context = FontContext.from_single_font(font)
+
+# Adjust kerning by a delta
+cmd = AdjustKerningCommand(pair=('A', 'V'), delta=-10)
+result = editor.execute(cmd, context)
+
+# Set kerning to absolute value
+cmd = SetKerningCommand(pair=('A', 'V'), value=-50)
+editor.execute(cmd, context)
+
+# Remove a kerning pair
+cmd = RemoveKerningCommand(pair=('A', 'V'))
+editor.execute(cmd, context)
+
+# Undo/Redo
+editor.undo()
+editor.redo()
+```
+
+### Margins Operations
+
+```python
+from ufo_spacing_lib import (
+    MarginsEditor,
+    FontContext,
+    AdjustMarginCommand,
+    SetMarginCommand,
+)
+
+editor = MarginsEditor()
+context = FontContext.from_single_font(font)
+
+# Adjust left margin (propagates to composites by default)
+cmd = AdjustMarginCommand(
+    glyph_name='A',
+    side='left',
+    delta=10,
+    propagate_to_composites=True
+)
+editor.execute(cmd, context)
+
+# Set right margin to absolute value
+cmd = SetMarginCommand(
+    glyph_name='A',
+    side='right',
+    value=50
+)
+editor.execute(cmd, context)
+```
+
+### Multi-Font Operations (Interpolation)
+
+```python
+# Create context for multiple fonts with scaling
+context = FontContext.from_linked_fonts(
+    fonts=[light_master, regular_master, bold_master],
+    primary=regular_master,
+    scales={
+        light_master: 0.8,
+        regular_master: 1.0,
+        bold_master: 1.3
+    }
+)
+
+# Command applies to all fonts with appropriate scaling
+cmd = AdjustKerningCommand(pair=('A', 'V'), delta=-10)
+editor.execute(cmd, context)
+# light_master: -8, regular_master: -10, bold_master: -13
+```
+
+### Event Callbacks
+
+```python
+def on_kerning_change(command, result):
+    print(f"Kerning changed: {command.description}")
+    refresh_ui()
+
+editor.on_change = on_kerning_change
+editor.on_undo = on_kerning_change
+editor.on_redo = on_kerning_change
+```
+
+### Preview/Simulation (VirtualFont)
+
+```python
+from ufo_spacing_lib import VirtualFont, FontContext, AdjustKerningCommand
+
+# Create virtual copy - isolates kerning/groups changes
+virtual = VirtualFont.from_font(font)
+
+# Work as usual - changes only affect virtual.kerning/groups
+context = FontContext.from_single_font(virtual)
+cmd = AdjustKerningCommand(pair=('A', 'V'), delta=-10)
+editor.execute(cmd, context)
+
+# Glyphs are live references - changes in font visible through virtual
+print(virtual['A'].leftMargin)  # Same as font['A'].leftMargin
+
+# Check what changed
+if virtual.has_changes():
+    for pair, (old, new) in virtual.get_kerning_diff().items():
+        print(f"{pair}: {old} -> {new}")
+
+# Apply to real font when ready, or reset
+virtual.apply_to(font)  # Writes changes to font
+# virtual.reset()       # Discards all changes
+```
+
+## Architecture
+
+```
+ufo_spacing_lib/
+├── __init__.py          # Main exports
+├── contexts.py          # FontContext class
+├── groups_core.py       # FontGroupsManager, KernPairInfo, resolve_kern_pair
+├── virtual.py           # VirtualFont for preview/simulation
+├── commands/
+│   ├── __init__.py
+│   ├── base.py          # Command ABC, CommandResult
+│   ├── kerning.py       # Kerning commands
+│   └── margins.py       # Margins commands
+└── editors/
+    ├── __init__.py
+    ├── kerning.py       # KerningEditor
+    └── margins.py       # MarginsEditor
+```
+
+## Font Object Interface
+
+The library is designed to work with any font object that implements this interface:
+
+### For Kerning Operations
+
+```python
+class FontKerning:
+    """Dict-like kerning access."""
+    def __getitem__(self, pair: Tuple[str, str]) -> int: ...
+    def __setitem__(self, pair: Tuple[str, str], value: int): ...
+    def __delitem__(self, pair: Tuple[str, str]): ...
+    def __contains__(self, pair: Tuple[str, str]) -> bool: ...
+    def get(self, pair: Tuple[str, str], default=None) -> Optional[int]: ...
+
+class Font:
+    kerning: FontKerning
+```
+
+### For Margins Operations
+
+```python
+class Glyph:
+    leftMargin: Optional[int]
+    rightMargin: Optional[int]
+    width: int
+    components: List[Component]  # Optional
+    
+    def moveBy(self, delta: Tuple[int, int]): ...
+    def changed(self): ...  # Optional
+
+class Component:
+    offset: Tuple[int, int]
+    def moveBy(self, delta: Tuple[int, int]): ...
+
+class Font:
+    def __getitem__(self, glyph_name: str) -> Glyph: ...
+    def __contains__(self, glyph_name: str) -> bool: ...
+    def getReverseComponentMapping(self) -> Dict[str, List[str]]: ...  # Optional
+```
+
+## Commands Reference
+
+### Kerning Commands
+
+| Command | Description |
+|---------|-------------|
+| `SetKerningCommand(pair, value)` | Set kerning to absolute value |
+| `AdjustKerningCommand(pair, delta)` | Adjust kerning by delta |
+| `RemoveKerningCommand(pair)` | Remove a kerning pair |
+| `CreateExceptionCommand(pair, value, side)` | Create kerning exception |
+
+### Margins Commands
+
+| Command | Description |
+|---------|-------------|
+| `SetMarginCommand(glyph, side, value)` | Set margin to absolute value |
+| `AdjustMarginCommand(glyph, side, delta)` | Adjust margin by delta |
+
+All commands support:
+- Multi-font operations via `FontContext`
+- Per-font scaling
+- Full undo/redo
+
+## Testing
+
+The library includes 100+ unit tests covering all components.
+
+```bash
+# Run all tests
+PYTHONPATH=src python3 -m unittest discover -s tests -v
+
+# Run specific test module
+PYTHONPATH=src python3 -m unittest tests.test_kerning_commands -v
+
+# With pytest (if installed)
+PYTHONPATH=src python3 -m pytest tests/ -v
+```
+
+### Test Coverage
+
+| Module | Tests | Coverage |
+|--------|-------|----------|
+| Kerning Commands | 25 | SetKerning, AdjustKerning, RemoveKerning, CreateException |
+| Editors | 20 | KerningEditor, MarginsEditor, undo/redo, callbacks |
+| Groups Manager | 30 | FontGroupsManager, add/remove/delete/rename groups |
+| VirtualFont | 27 | Creation, isolation, glyph access, diff tracking, apply/reset |
+
+## License
+
+MIT License
+
+## Author
+
+Alexander Lubovenko 
+lubovenko@gmail.com 
+github.com/typedev
+

ufo_spacing_lib-0.1.0/README.md

@@ -0,0 +1,268 @@
+# UFO Spacing Library
+
+A framework-agnostic Python library for managing font spacing (kerning and margins) with full undo/redo support. Designed to work with UFO-compatible font objects.
+
+## Features
+
+- **Framework Independent**: Works with any font editor that provides compatible font objects
+- **Undo/Redo Support**: Full command pattern implementation with unlimited history
+- **Multi-Font Operations**: Support for linked/interpolated fonts with per-font scaling
+- **Preview/Simulation**: VirtualFont wrapper for testing changes without modifying real font
+- **Composite Propagation**: Automatic margin propagation to composite glyphs
+- **Well Documented**: Comprehensive docstrings and type hints throughout
+
+## Installation
+
+```bash
+# From PyPI (when published)
+pip install ufo-spacing-lib
+
+# From source
+pip install -e .
+
+# Or with uv
+uv pip install -e .
+```
+
+## Quick Start
+
+### Kerning Operations
+
+```python
+from ufo_spacing_lib import (
+    KerningEditor,
+    FontContext,
+    AdjustKerningCommand,
+    SetKerningCommand,
+    RemoveKerningCommand,
+)
+
+# Create an editor
+editor = KerningEditor()
+
+# Create a context for your font
+context = FontContext.from_single_font(font)
+
+# Adjust kerning by a delta
+cmd = AdjustKerningCommand(pair=('A', 'V'), delta=-10)
+result = editor.execute(cmd, context)
+
+# Set kerning to absolute value
+cmd = SetKerningCommand(pair=('A', 'V'), value=-50)
+editor.execute(cmd, context)
+
+# Remove a kerning pair
+cmd = RemoveKerningCommand(pair=('A', 'V'))
+editor.execute(cmd, context)
+
+# Undo/Redo
+editor.undo()
+editor.redo()
+```
+
+### Margins Operations
+
+```python
+from ufo_spacing_lib import (
+    MarginsEditor,
+    FontContext,
+    AdjustMarginCommand,
+    SetMarginCommand,
+)
+
+editor = MarginsEditor()
+context = FontContext.from_single_font(font)
+
+# Adjust left margin (propagates to composites by default)
+cmd = AdjustMarginCommand(
+    glyph_name='A',
+    side='left',
+    delta=10,
+    propagate_to_composites=True
+)
+editor.execute(cmd, context)
+
+# Set right margin to absolute value
+cmd = SetMarginCommand(
+    glyph_name='A',
+    side='right',
+    value=50
+)
+editor.execute(cmd, context)
+```
+
+### Multi-Font Operations (Interpolation)
+
+```python
+# Create context for multiple fonts with scaling
+context = FontContext.from_linked_fonts(
+    fonts=[light_master, regular_master, bold_master],
+    primary=regular_master,
+    scales={
+        light_master: 0.8,
+        regular_master: 1.0,
+        bold_master: 1.3
+    }
+)
+
+# Command applies to all fonts with appropriate scaling
+cmd = AdjustKerningCommand(pair=('A', 'V'), delta=-10)
+editor.execute(cmd, context)
+# light_master: -8, regular_master: -10, bold_master: -13
+```
+
+### Event Callbacks
+
+```python
+def on_kerning_change(command, result):
+    print(f"Kerning changed: {command.description}")
+    refresh_ui()
+
+editor.on_change = on_kerning_change
+editor.on_undo = on_kerning_change
+editor.on_redo = on_kerning_change
+```
+
+### Preview/Simulation (VirtualFont)
+
+```python
+from ufo_spacing_lib import VirtualFont, FontContext, AdjustKerningCommand
+
+# Create virtual copy - isolates kerning/groups changes
+virtual = VirtualFont.from_font(font)
+
+# Work as usual - changes only affect virtual.kerning/groups
+context = FontContext.from_single_font(virtual)
+cmd = AdjustKerningCommand(pair=('A', 'V'), delta=-10)
+editor.execute(cmd, context)
+
+# Glyphs are live references - changes in font visible through virtual
+print(virtual['A'].leftMargin)  # Same as font['A'].leftMargin
+
+# Check what changed
+if virtual.has_changes():
+    for pair, (old, new) in virtual.get_kerning_diff().items():
+        print(f"{pair}: {old} -> {new}")
+
+# Apply to real font when ready, or reset
+virtual.apply_to(font)  # Writes changes to font
+# virtual.reset()       # Discards all changes
+```
+
+## Architecture
+
+```
+ufo_spacing_lib/
+├── __init__.py          # Main exports
+├── contexts.py          # FontContext class
+├── groups_core.py       # FontGroupsManager, KernPairInfo, resolve_kern_pair
+├── virtual.py           # VirtualFont for preview/simulation
+├── commands/
+│   ├── __init__.py
+│   ├── base.py          # Command ABC, CommandResult
+│   ├── kerning.py       # Kerning commands
+│   └── margins.py       # Margins commands
+└── editors/
+    ├── __init__.py
+    ├── kerning.py       # KerningEditor
+    └── margins.py       # MarginsEditor
+```
+
+## Font Object Interface
+
+The library is designed to work with any font object that implements this interface:
+
+### For Kerning Operations
+
+```python
+class FontKerning:
+    """Dict-like kerning access."""
+    def __getitem__(self, pair: Tuple[str, str]) -> int: ...
+    def __setitem__(self, pair: Tuple[str, str], value: int): ...
+    def __delitem__(self, pair: Tuple[str, str]): ...
+    def __contains__(self, pair: Tuple[str, str]) -> bool: ...
+    def get(self, pair: Tuple[str, str], default=None) -> Optional[int]: ...
+
+class Font:
+    kerning: FontKerning
+```
+
+### For Margins Operations
+
+```python
+class Glyph:
+    leftMargin: Optional[int]
+    rightMargin: Optional[int]
+    width: int
+    components: List[Component]  # Optional
+    
+    def moveBy(self, delta: Tuple[int, int]): ...
+    def changed(self): ...  # Optional
+
+class Component:
+    offset: Tuple[int, int]
+    def moveBy(self, delta: Tuple[int, int]): ...
+
+class Font:
+    def __getitem__(self, glyph_name: str) -> Glyph: ...
+    def __contains__(self, glyph_name: str) -> bool: ...
+    def getReverseComponentMapping(self) -> Dict[str, List[str]]: ...  # Optional
+```
+
+## Commands Reference
+
+### Kerning Commands
+
+| Command | Description |
+|---------|-------------|
+| `SetKerningCommand(pair, value)` | Set kerning to absolute value |
+| `AdjustKerningCommand(pair, delta)` | Adjust kerning by delta |
+| `RemoveKerningCommand(pair)` | Remove a kerning pair |
+| `CreateExceptionCommand(pair, value, side)` | Create kerning exception |
+
+### Margins Commands
+
+| Command | Description |
+|---------|-------------|
+| `SetMarginCommand(glyph, side, value)` | Set margin to absolute value |
+| `AdjustMarginCommand(glyph, side, delta)` | Adjust margin by delta |
+
+All commands support:
+- Multi-font operations via `FontContext`
+- Per-font scaling
+- Full undo/redo
+
+## Testing
+
+The library includes 100+ unit tests covering all components.
+
+```bash
+# Run all tests
+PYTHONPATH=src python3 -m unittest discover -s tests -v
+
+# Run specific test module
+PYTHONPATH=src python3 -m unittest tests.test_kerning_commands -v
+
+# With pytest (if installed)
+PYTHONPATH=src python3 -m pytest tests/ -v
+```
+
+### Test Coverage
+
+| Module | Tests | Coverage |
+|--------|-------|----------|
+| Kerning Commands | 25 | SetKerning, AdjustKerning, RemoveKerning, CreateException |
+| Editors | 20 | KerningEditor, MarginsEditor, undo/redo, callbacks |
+| Groups Manager | 30 | FontGroupsManager, add/remove/delete/rename groups |
+| VirtualFont | 27 | Creation, isolation, glyph access, diff tracking, apply/reset |
+
+## License
+
+MIT License
+
+## Author
+
+Alexander Lubovenko 
+lubovenko@gmail.com 
+github.com/typedev
+

ufo_spacing_lib-0.1.0/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "ufo-spacing-lib"
+version = "0.1.0"
+description = "Font spacing management library for UFO-compatible fonts (kerning, margins, groups)"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "Alexander Lubovenko", email = "lubovenko@gmail.com" }
+]
+keywords = [
+    "font",
+    "typography",
+    "kerning",
+    "spacing",
+    "ufo",
+    "fonttools",
+    "type-design"
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Text Processing :: Fonts",
+    "Topic :: Multimedia :: Graphics :: Graphics Conversion",
+    "Typing :: Typed",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov",
+    "ruff",
+    "mypy",
+]
+
+[project.urls]
+Homepage = "https://github.com/typedev/ufo-spacing-lib"
+Repository = "https://github.com/typedev/ufo-spacing-lib"
+Documentation = "https://github.com/typedev/ufo-spacing-lib#readme"
+Issues = "https://github.com/typedev/ufo-spacing-lib/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ufo_spacing_lib"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+]
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_functions = "test_*"
+