pyrmute 0.1.0__py3-none-any.whl

pyrmute/types.py

@@ -0,0 +1,26 @@
+"""Type aliases needed in the package."""
+
+from collections.abc import Callable
+from typing import Any, TypeAlias, TypeVar
+
+from pydantic import BaseModel
+
+from .model_version import ModelVersion
+
+DecoratedBaseModel = TypeVar("DecoratedBaseModel", bound=BaseModel)
+
+JsonValue: TypeAlias = dict[str, Any] | list[Any] | str | int | float | bool | None
+JsonSchema: TypeAlias = dict[str, JsonValue]
+JsonSchemaDefinitions: TypeAlias = dict[str, JsonSchema]
+JsonSchemaGenerator: TypeAlias = Callable[[type[BaseModel]], JsonSchema]
+SchemaGenerators: TypeAlias = dict[ModelVersion, JsonSchemaGenerator]
+
+MigrationData: TypeAlias = dict[str, Any]
+MigrationFunc: TypeAlias = Callable[[MigrationData], MigrationData]
+
+MigrationKey: TypeAlias = tuple[ModelVersion, ModelVersion]
+MigrationMap: TypeAlias = dict[MigrationKey, MigrationFunc]
+
+ModelName: TypeAlias = str
+ModelMetadata: TypeAlias = tuple[ModelName, ModelVersion]
+VersionedModels: TypeAlias = dict[ModelVersion, type[BaseModel]]

pyrmute-0.1.0.dist-info/METADATA

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: pyrmute
+Version: 0.1.0
+Summary: Pydantic model migrations and schemas
+Author-email: Matt Ferrera <mattferrera@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/mferrera/pyrmute
+Project-URL: Repository, https://github.com/mferrera/pyrmute
+Project-URL: Documentation, https://github.com/mferrera/pyrmute
+Keywords: pydantic,migration,versioning,schema
+Classifier: Development Status :: 3 - Alpha
+Classifier: Topic :: Utilities
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Natural Language :: English
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# pyrmute
+
+[![ci](https://img.shields.io/github/actions/workflow/status/mferrera/pyrmute/ci.yml?branch=main&logo=github&label=ci)](https://github.com/mferrera/pyrmute/actions?query=event%3Apush+branch%3Amain+workflow%3Aci)
+[![pypi](https://img.shields.io/pypi/v/pyrmute.svg)](https://pypi.python.org/pypi/pyrmute)
+[![versions](https://img.shields.io/pypi/pyversions/pyrmute.svg)](https://github.com/mferrera/pyrmute)
+[![license](https://img.shields.io/github/license/pyrmute/pyrmute.svg)](https://github.com/mferrera/pyrmute/blob/main/LICENSE)
+
+Pydantic model migrations and schema management with semantic versioning.
+
+Pyrmute helps you evolve your data models over time without breaking changes.
+Version your Pydantic models, define migrations between versions, and
+automatically transform legacy data to current schemas. Export JSON schemas
+for all versions to maintain API contracts.
+
+**Key features:**
+- **Version your models** - Use semantic versioning to track model evolution
+- **Automatic migrations** - Chain migrations across multiple versions (1.0.0 → 2.0.0 → 3.0.0)
+- **Validated transformations** - Migrations return validated Pydantic models by default
+- **Schema export** - Generate JSON schemas for all versions, with support for `$ref` to external schemas and custom schema generators
+- **Nested model support** - Automatically migrates nested Pydantic models
+
+## Help
+
+See [documentation](https://mferrera.github.io/pyrmute/) for more details.
+
+## Installation
+
+Install using `pip install -U pyrmute`.
+
+## Simple Example
+
+```python
+from pydantic import BaseModel
+from pyrmute import ModelManager, MigrationData
+
+manager = ModelManager()
+
+
+@manager.model("User", "1.0.0")
+class UserV1(BaseModel):
+    """Version 1.0.0: Initial user model."""
+    name: str
+    age: int
+
+
+@manager.model("User", "2.0.0")
+class UserV2(BaseModel):
+    """Version 2.0.0: Split name into first/last."""
+    first_name: str
+    last_name: str
+    age: int
+
+
+@manager.model("User", "3.0.0")
+class UserV3(BaseModel):
+    """Version 3.0.0: Add email, make age optional."""
+    first_name: str
+    last_name: str
+    email: str
+    age: int | None = None
+
+
+# Define migrations
+@manager.migration("User", "1.0.0", "2.0.0")
+def split_name(data: MigrationData) -> MigrationData:
+    parts = data["name"].split(" ", 1)
+    return {
+        "first_name": parts[0],
+        "last_name": parts[1] if len(parts) > 1 else "",
+        "age": data["age"],
+    }
+
+
+@manager.migration("User", "2.0.0", "3.0.0")
+def add_email(data: MigrationData) -> MigrationData:
+    return {**data, "email": f"{data['first_name'].lower()}@example.com"}
+
+
+# Migrate old data forward, from raw data or dumped from the Pydantic model
+legacy_data = {"name": "John Doe", "age": 30}
+# Returns a validated Pydantic model
+current_user = manager.migrate(legacy_data, "User", "1.0.0", "3.0.0")
+
+print(current_user)
+# first_name='John' last_name='Doe' email='john@example.com' age=30
+
+# Export schemas for all versions
+manager.dump_schemas("schemas/")
+# Creates: schemas/User_v1.0.0.json, schemas/User_v2.0.0.json, schemas/User_v3.0.0.json
+```
+
+## Contributing
+
+For guidance on setting up a development environment and how to make a
+contribution to pyrmute, see
+[Contributing to pyrmute](https://mferrera.github.io/pyrmute/contributing/).
+
+## Reporting a Security Vulnerability
+
+See our [security policy](https://github.com/mferrera/pyrmute/security/policy).

pyrmute-0.1.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+pyrmute/__init__.py,sha256=wGuYwo2F3zPXnB_HLJsmjt7jbZVfCcyVwf0J78KvwzA,516
+pyrmute/_migration_manager.py,sha256=Z9Ie-fxJmOsmBw7oGWGHDrcNvr0aANlO6AqnBmJyYSA,9521
+pyrmute/_registry.py,sha256=_fZGRQtdkfCsrCrF6GLUuMmHmyq8up9hF6aS9FboQZA,5572
+pyrmute/_schema_manager.py,sha256=UdDC9j5nI-ljy9zKnfjhukzM4zfF-Edwu6P7CsdI7Xw,12581
+pyrmute/_version.py,sha256=5jwwVncvCiTnhOedfkzzxmxsggwmTBORdFL_4wq0ZeY,704
+pyrmute/model_manager.py,sha256=6rh0hXzZAaGv245RpVaAgjIRJ9s5DLmaRbsJAgwGQuQ,8289
+pyrmute/model_version.py,sha256=_vyLcIfOzHXrumPqzDSuNZMAZGqFh1ZYv6g933O_aH0,1801
+pyrmute/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyrmute/types.py,sha256=NmlBA0ohFjpAIyZ6EvhbEigBV645LCZ-k8vaHjtB7Z4,978
+pyrmute-0.1.0.dist-info/licenses/LICENSE,sha256=otWInySiZeGwhHqQQ7n7nxM5QBSBe2CzeGEmQDZEz8Q,1119
+pyrmute-0.1.0.dist-info/METADATA,sha256=0t3BYtlBAYNORci6prJdVpgzA9Q8A0kjHvTrw8cJCNs,4515
+pyrmute-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyrmute-0.1.0.dist-info/top_level.txt,sha256=C8QtzqE6yBHkeewSp1QewvsyeHj_VQLYjSa5HLtMiow,8
+pyrmute-0.1.0.dist-info/RECORD,,

pyrmute-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyrmute-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 to present Matt Ferrera and individual contributors.
+
+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.

pyrmute-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyrmute