scruby-plugin 2.2.6

Library for creating Scruby plugins.

Scruby-Plugin

Library for creating plugins for Scruby.

Installation

# For Scruby version 0
uv add "scruby-plugin>=0.8.2,<1.0.0"
# For Scruby version 1
uv add "scruby-plugin>=1.0.0,<2.0.0"
# For Scruby version 2
uv add "scruby-plugin>=2.0.0,<3.0.0"

Usage

from typing import Any
from scruby_plugin import ScrubyPlugin

class PluginName(ScrubyPlugin):
    def __init__(self, scruby_self: Any) -> None:
        ScrubyPlugin.__init__(self, scruby_self)

    ...your code...

Example

import anyio
from typing import Annotated, Any
from pydantic import Field
from scruby import Scruby, ScrubyModel
from scruby_plugin import ScrubyPlugin
from pprint import pprint as pp


# Create plugin
class CollectionMeta(ScrubyPlugin):
    def __init__(self, scruby_self: Scruby) -> None:
        ScrubyPlugin.__init__(self, scruby_self)

    async def get(self) -> Any:
        scruby_self = self.scruby_self()
        return await scruby_self.get_meta()


class Car(ScrubyModel):
    """Car model."""

    brand: str = Field(frozen=True)
    model: str = Field(frozen=True)
    year: int
    power_reserve: int
    # key is always at bottom
    key: Annotated[
        str,
        Field(
            frozen=True,
            default_factory=lambda data: f"{data['brand']}:{data['model']}",
        ),
    ]


async def main() -> None:
    """Example."""
    # Activate database.
    Scruby.run(plugins=[CollectionMeta])

    # Get collection `Car`.
    car_coll = Scruby(Car)
    # Get metadata of collection
    meta = await car_coll.plugins.collectionMeta.get()
    # Print to console
    pp(meta)
    #
    # Full database deletion.
    # Hint: The main purpose is tests.
    Scruby.napalm()

if __name__ == "__main__":
    anyio.run(main)