morphic 0.1.0__py3-none-any.whl

morphic-0.1.0.dist-info/METADATA

@@ -0,0 +1,333 @@
+Metadata-Version: 2.4
+Name: morphic
+Version: 0.1.0
+Summary: Dynamic Python utilities for class registration, creation, and type checking
+Author-email: Abhishek Divekar <adivekar@utexas.edu>
+License-File: LICENSE
+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 :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10.9
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: all
+Requires-Dist: black>=23.0.0; extra == 'all'
+Requires-Dist: mike>=2.0.0; extra == 'all'
+Requires-Dist: mkdocs-material>=9.5.0; extra == 'all'
+Requires-Dist: mkdocs>=1.6.0; extra == 'all'
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == 'all'
+Requires-Dist: mypy>=1.0.0; extra == 'all'
+Requires-Dist: pydantic>=2.0.0; extra == 'all'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
+Requires-Dist: pytest>=7.0.0; extra == 'all'
+Requires-Dist: ruff>=0.1.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pydantic>=2.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mike>=2.0.0; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
+Requires-Dist: mkdocs>=1.6.0; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# Morphic
+
+[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue.svg)](https://adivekar-utexas.github.io/morphic/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Dynamic Python utilities for class registration, creation, and type checking.
+
+## Features
+
+- **Registry**: Dynamic class registration and factory pattern for building extensible architectures
+- **AutoEnum**: Automatic enumeration creation from class hierarchies with type safety
+- **Typed**: Enhanced data modeling with validation and serialization capabilities
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install morphic
+```
+
+### From Source
+
+```bash
+pip install git+https://github.com/adivekar-utexas/morphic.git
+```
+
+### Development Installation
+
+```bash
+git clone https://github.com/adivekar-utexas/morphic.git
+cd morphic
+
+# Install with all dependencies (dev + docs)
+pip install -e ".[all]"
+
+# Or install specific dependency groups
+pip install -e ".[dev]"      # Development dependencies only
+pip install -e ".[docs]"     # Documentation dependencies only
+pip install -e ".[dev,docs]" # Both dev and docs
+```
+
+## Quick Start
+
+### Registry System: Inheritance-Based Class Registration
+
+```python
+from morphic import Registry
+from abc import ABC, abstractmethod
+
+# Create base registry class
+class NotificationService(Registry, ABC):
+    @abstractmethod
+    def send(self, to: str, message: str) -> bool:
+        pass
+
+# Classes automatically register when inheriting
+class EmailService(NotificationService):
+    aliases = ["email", "mail"]  # Multiple aliases supported
+
+    def __init__(self, smtp_server: str = "localhost"):
+        self.smtp_server = smtp_server
+
+    def send(self, to: str, message: str) -> bool:
+        print(f"Sending email to {to} via {self.smtp_server}")
+        return True
+
+class SMSService(NotificationService):
+    aliases = ["sms", "text"]
+
+    def send(self, to: str, message: str) -> bool:
+        print(f"Sending SMS to {to}")
+        return True
+
+# Hierarchical factory pattern - create instances through base class
+email_service = NotificationService.of("EmailService", smtp_server="mail.example.com")
+sms_service = NotificationService.of("sms")  # Works with aliases too!
+
+# Direct instantiation works for concrete classes
+email_direct = EmailService.of(smtp_server="direct.mail.com")
+
+# Use the services
+email_service.send("user@example.com", "Hello!")
+sms_service.send("+1234567890", "Hello!")
+```
+
+### AutoEnum: Ultra-Fast Fuzzy-Matching Enums
+
+```python
+from morphic import AutoEnum, alias, auto
+import json
+
+# Create enum with fuzzy matching and aliases
+class TaskStatus(AutoEnum):
+    PENDING = alias("waiting", "queued", "not_started")
+    RUNNING = alias("active", "in_progress", "executing")
+    COMPLETE = alias("done", "finished", "success")
+    FAILED = alias("error", "failure", "crashed")
+
+# Fuzzy matching works with various formats
+status1 = TaskStatus("pending")       # Direct match
+status2 = TaskStatus("IN PROGRESS")   # Case insensitive + space handling
+status3 = TaskStatus("not-started")   # Alias with different formatting
+status4 = TaskStatus("Done")          # Alias with different case
+
+# JSON compatibility (unlike standard enums!)
+data = [TaskStatus.PENDING, TaskStatus.RUNNING]
+json_str = json.dumps(data)  # Works! -> '["PENDING", "RUNNING"]'
+recovered = TaskStatus.convert_list(json.loads(json_str))  # Back to enums!
+
+# Dynamic enum creation
+Priority = AutoEnum.create("Priority", ["low", "medium", "high", "urgent"])
+print(Priority.Low)        # Low
+print(Priority("MEDIUM"))  # Medium (fuzzy matched)
+
+# Perfect for configuration and user input
+config_status = TaskStatus(user_input)  # Handles "In Progress", "IN_PROGRESS", etc.
+```
+
+### Typed
+
+```python
+from morphic import Typed
+from typing import Optional, List
+
+class User(Typed):
+    name: str
+    email: str
+    age: int
+    is_active: bool = True
+    bio: Optional[str] = None
+    tags: List[str] = []  # Default empty list
+
+    def validate(self):
+        if self.age < 0:
+            raise ValueError("Age must be non-negative")
+        if "@" not in self.email:
+            raise ValueError("Invalid email format")
+
+# Instantiate like any class with auto type-conversion:
+user = User(
+    name="Alice Johnson",
+    email="alice@example.com",
+    age="30",  # String automatically converts to int
+    is_active="true",  # String automatically converts to bool
+    tags=("python", "ai", "data"),  # Tuple of strings converted to list of strings.
+)
+print(f"User: {user.name}, Age: {user.age} ({type(user.age)}), Tags: {user.tags}")
+# Output: 
+# User: Alice Johnson, Age: 30 (<class 'int'>), Tags: ['python', 'ai', 'data']
+
+# Create from dict:
+user = User.from_dict({
+    "name": "Alice Johnson",
+    "email": "alice@example.com",
+    "age": "30",  # String automatically converts to int
+    "is_active": "true",  # String automatically converts to bool
+    "tags": ["python", "ai", "data"]  # List of strings
+})
+print(f"User: {user.name}, Age: {user.age} ({type(user.age)}), Tags: {user.tags}")
+# Output: 
+# Same as above.
+
+# Hierarchical field handling for nested data
+class Company(Typed):
+    name: str
+    employees: List[User]  # Automatically converts dicts to User instances
+
+company_data = {
+    "name": "TechCorp",
+    "employees": [
+        {"name": "Alice", "email": "alice@tech.com", "age": "30"},
+        {"name": "Bob", "email": "bob@tech.com", "age": "25"}
+    ]
+}
+
+company = Company.from_dict(company_data)
+print(f"Company: {company.name}, Employees: {len(company.employees)}")
+```
+
+## Documentation
+
+Comprehensive documentation is available at [https://adivekar.github.io/morphic/](https://adivekar.github.io/morphic/)
+
+### Building Documentation Locally
+
+To build and serve the documentation locally:
+
+```bash
+# Install documentation dependencies
+pip install -e ".[docs]"
+
+# Serve documentation locally
+mkdocs serve
+```
+
+The documentation will be available at http://localhost:8000
+
+### Documentation Structure
+
+- **[User Guide](https://adivekar.github.io/morphic/user-guide/getting-started/)**: Comprehensive tutorials and examples
+- **[API Reference](https://adivekar.github.io/morphic/api/)**: Detailed API documentation generated from docstrings
+- **[Examples](https://adivekar.github.io/morphic/examples/)**: Real-world usage examples and patterns
+- **[Contributing](https://adivekar.github.io/morphic/contributing/)**: Guidelines for contributors
+
+## Development
+
+### Setting Up Development Environment
+
+1. **Clone the repository**:
+   ```bash
+   git clone https://github.com/adivekar/morphic.git
+   cd morphic
+   ```
+
+2. **Create virtual environment**:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. **Install in development mode**:
+   ```bash
+   # Install all dependencies (recommended for contributors)
+   pip install -e ".[all]"
+
+   # Or install specific groups
+   pip install -e ".[dev]"      # Just development tools
+   pip install -e ".[docs]"     # Just documentation tools
+   ```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=morphic --cov-report=html
+
+# Run specific test file
+pytest tests/test_registry.py
+```
+
+### Code Quality
+
+```bash
+# Format code
+black src/ tests/
+
+# Lint code
+ruff check src/ tests/
+
+# Type checking
+mypy src/
+```
+
+### Documentation Deployment
+
+Documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch via GitHub Actions. The deployment workflow:
+
+1. **Builds documentation** using MkDocs with Material theme
+2. **Generates API documentation** automatically from docstrings using mkdocstrings
+3. **Deploys to GitHub Pages** at https://adivekar.github.io/morphic/
+
+## Performance
+
+Morphic is optimized for production use:
+- **AutoEnum**: 5.7M+ lookups/second with fuzzy matching
+- **Registry**: O(1) class lookup with hierarchical inheritance
+- **Typed**: Efficient type conversion with caching
+
+## Requirements
+
+- Python 3.10.9 or higher
+- typing-extensions >= 4.0.0
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](https://adivekar.github.io/morphic/contributing/) for details on:
+
+- Setting up the development environment
+- Running tests and quality checks
+- Code style and documentation standards
+- Pull request process
+
+## License
+
+MIT License - see the [LICENSE](LICENSE) file for details.

morphic-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+morphic/__init__.py,sha256=HzrUZ6uJDk6chMhHf9TxQcex_LPJ32a7rfAwFqxvf1Y,313
+morphic/autoenum.py,sha256=1v31PMEyWkdVygsNkwSjpLZdHE99b3tVQDB371-k428,14887
+morphic/registry.py,sha256=hT01NBkAYLVCvnU9A_NsrMFoc29q1zoICgh7PB6nmBE,38767
+morphic/typed.py,sha256=b50sriDINA0Gtn5Pdd5-O1527PFNVDsWRzpYfEvUy2c,56218
+morphic-0.1.0.dist-info/METADATA,sha256=-MPOE5oD7dV4_R4U9yDZ-Xmd00Kx9mgaHcgZEM0kiEs,10323
+morphic-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+morphic-0.1.0.dist-info/licenses/LICENSE,sha256=Fu83sfpznMNp6N5-PYx62oGz7AhwUOgI7dWuRL-Hh3M,1072
+morphic-0.1.0.dist-info/RECORD,,

morphic-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

morphic-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Abhishek Divekar
+
+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.