pyrmute 0.1.0__tar.gz

pyrmute-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  release:
+    types:
+      - created
+  schedule:
+    # Run nightly to check that tests are working with latest dependencies
+    - cron: "0 0 * * *"
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Set up Python
+        run: uv sync --python ${{ matrix.python-version }} --all-extras --frozen
+
+      - name: Ruff check
+        if: ${{ always() }}
+        run: uv run ruff check
+
+      - name: Ruff format
+        if: ${{ always() }}
+        run: uv run ruff format --check
+
+      - name: Check typing with mypy
+        if: ${{ always() }}
+        run: uv run mypy src tests
+
+      - name: Run tests
+        if: ${{ always() }}
+        run: uv run pytest

pyrmute-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish Python distribution to PyPI
+
+on:
+  release:
+    types: [created]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  publish-pypi-package:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+
+    environment:
+      name: release
+      url: https://pypi.org/project/pyrmute/
+
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: |
+          pip install -U pip
+          pip install build
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pyrmute-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# uv
+.python-version
+
+# cov
+.coverage
+
+# setuptools-scm version
+_version.py

pyrmute-0.1.0/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/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,100 @@
+# 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/pyproject.toml

@@ -0,0 +1,133 @@
+[build-system]
+requires = [
+    "setuptools",
+    "setuptools_scm[toml]",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyrmute"
+description = "Pydantic model migrations and schemas"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [
+    { name = "Matt Ferrera", email = "mattferrera@gmail.com" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Topic :: Utilities",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Natural Language :: English",
+]
+keywords = ["pydantic", "migration", "versioning", "schema"]
+dynamic = ["version"]
+dependencies = [
+    "pydantic",
+]
+
+[project.optional-dependencies]
+dev = [
+    "mypy",
+    "pytest",
+    "pytest-cov",
+    "pytest-mock",
+    "pytest-xdist",
+    "ruff",
+]
+
+[project.urls]
+Homepage = "https://github.com/mferrera/pyrmute"
+Repository = "https://github.com/mferrera/pyrmute"
+Documentation = "https://github.com/mferrera/pyrmute"
+
+[tool.setuptools_scm]
+write_to = "src/pyrmute/_version.py"
+
+[tool.coverage.run]
+omit = [
+    "_version.py",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+]
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+disallow_untyped_calls = true
+disallow_subclassing_any = true
+extra_checks = true
+strict_equality = true
+warn_redundant_casts = true
+warn_unused_configs = true
+warn_unused_ignores = true
+warn_return_any = true
+warn_unreachable = true
+no_implicit_reexport = true
+strict_optional = true
+disallow_any_unimported = true
+no_implicit_optional = true
+show_error_codes = true
+show_column_numbers = true
+pretty = true
+
+[tool.pytest.ini_options]
+addopts = "-n auto --cov src/ --cov-report term-missing"
+norecursedirs = [
+    ".git",
+    ".tox",
+    ".env",
+    ".venv",
+    "dist",
+    "build",
+]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 88
+exclude = ["_version.py"]
+
+[tool.ruff.lint]
+select = [
+    "B",  # flake-8-bugbear
+    "C",  # pylint-convention
+    "C90",  # mccabe
+    "D",  # pydocstyle
+    "E",  # pycodestyle-error
+    "F",  # pyflakes
+    "G",  # logging-format
+    "I",  # isort
+    "LOG",  # logging
+    "NPY",  # numpy
+    "PIE",  # flake8-pie
+    "PL",  # pylint
+    "Q",  # flake8-quotes
+    "RET",  # flake8-return
+    "RSE",  # flake8-raise
+    "RUF",  # ruff rules
+    "SIM",  # flake8-simplify
+    "TCH",  # flake8-type-checking
+    "TID",  # flake8-tidy-imports
+    "UP",  # pyupgrade
+    "W",  # pylint-warnings
+]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

pyrmute-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyrmute-0.1.0/src/pyrmute/__init__.py

@@ -0,0 +1,20 @@
+"""pyrmute - versioned Pydantic models and schemas with migrations.
+
+A package for managing versioned Pydantic models with automatic migrations
+and schema management.
+"""
+
+from ._version import __version__
+from .model_manager import ModelManager
+from .model_version import ModelVersion
+from .types import JsonSchema, MigrationData, MigrationFunc, ModelMetadata
+
+__all__ = [
+    "JsonSchema",
+    "MigrationData",
+    "MigrationFunc",
+    "ModelManager",
+    "ModelMetadata",
+    "ModelVersion",
+    "__version__",
+]