59cdf5ee01
Complete package renaming and platform migration: Package Name Changes: - Rename package from 'wikijs-python-sdk' to 'py-wikijs' - Update setup.py package name - Update pyproject.toml package name - Users can now install with: pip install py-wikijs URL Migration (Gitea → GitHub): - Replace all Gitea URLs with GitHub URLs - Update repository: github.com/l3ocho/py-wikijs - Update issue tracker: github.com/l3ocho/py-wikijs/issues - Update documentation links - Fix URL path format (/src/branch/main/ → /blob/main/) Documentation Updates: - Update README.md badges (PyPI, GitHub) - Update installation instructions (pip install py-wikijs) - Update all doc references to new package name - Update all examples with GitHub URLs - Update DEPLOYMENT_READY.md with new package name - Update deployment.md with new package name Testing: - Successfully built py_wikijs-0.1.0.tar.gz (138 KB) - Successfully built py_wikijs-0.1.0-py3-none-any.whl (66 KB) - Package installs correctly: pip install py-wikijs - Imports work: from wikijs import WikiJSClient - Package metadata correct (Home-page: github.com/l3ocho/py-wikijs) Breaking Changes: - Package name changed from wikijs-python-sdk to py-wikijs - Repository migrated from Gitea to GitHub - All URLs updated to GitHub Users should now: pip install py-wikijs # Instead of wikijs-python-sdk 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
93 lines
2.5 KiB
Python
93 lines
2.5 KiB
Python
"""Base model functionality for py-wikijs."""
|
|
|
|
from datetime import datetime
|
|
from typing import Any, Dict, Optional
|
|
|
|
from pydantic import BaseModel as PydanticBaseModel
|
|
from pydantic import ConfigDict, field_serializer
|
|
|
|
|
|
class BaseModel(PydanticBaseModel):
|
|
"""Base model with common functionality for all data models.
|
|
|
|
Provides:
|
|
- Automatic validation via Pydantic
|
|
- JSON serialization/deserialization
|
|
- Field aliases for API compatibility
|
|
- Consistent datetime handling
|
|
"""
|
|
|
|
model_config = ConfigDict(
|
|
# Allow population by field name or alias
|
|
populate_by_name=True,
|
|
# Validate assignment to attributes
|
|
validate_assignment=True,
|
|
# Use enum values instead of names
|
|
use_enum_values=True,
|
|
# Allow extra fields for forward compatibility
|
|
extra="ignore",
|
|
)
|
|
|
|
def to_dict(self, exclude_none: bool = True) -> Dict[str, Any]:
|
|
"""Convert model to dictionary.
|
|
|
|
Args:
|
|
exclude_none: Whether to exclude None values
|
|
|
|
Returns:
|
|
Dictionary representation of the model
|
|
"""
|
|
return self.model_dump(exclude_none=exclude_none, by_alias=True)
|
|
|
|
def to_json(self, exclude_none: bool = True) -> str:
|
|
"""Convert model to JSON string.
|
|
|
|
Args:
|
|
exclude_none: Whether to exclude None values
|
|
|
|
Returns:
|
|
JSON string representation of the model
|
|
"""
|
|
return self.model_dump_json(exclude_none=exclude_none, by_alias=True)
|
|
|
|
@classmethod
|
|
def from_dict(cls, data: Dict[str, Any]) -> "BaseModel":
|
|
"""Create model instance from dictionary.
|
|
|
|
Args:
|
|
data: Dictionary data
|
|
|
|
Returns:
|
|
Model instance
|
|
"""
|
|
return cls(**data)
|
|
|
|
@classmethod
|
|
def from_json(cls, json_str: str) -> "BaseModel":
|
|
"""Create model instance from JSON string.
|
|
|
|
Args:
|
|
json_str: JSON string
|
|
|
|
Returns:
|
|
Model instance
|
|
"""
|
|
return cls.model_validate_json(json_str)
|
|
|
|
|
|
class TimestampedModel(BaseModel):
|
|
"""Base model with timestamp fields."""
|
|
|
|
created_at: Optional[datetime] = None
|
|
updated_at: Optional[datetime] = None
|
|
|
|
@field_serializer('created_at', 'updated_at')
|
|
def serialize_datetime(self, value: Optional[datetime]) -> Optional[str]:
|
|
"""Serialize datetime to ISO format."""
|
|
return value.isoformat() if value else None
|
|
|
|
@property
|
|
def is_new(self) -> bool:
|
|
"""Check if this is a new (unsaved) model."""
|
|
return self.created_at is None
|