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"
# For Scruby version 3
uv add "scruby-plugin>=3.0.0,<4.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)
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file scruby_plugin-3.1.0-py3-none-any.whl.
File metadata
- Download URL: scruby_plugin-3.1.0-py3-none-any.whl
- Upload date:
- Size: 4.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"44","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c1c5e4676bb01adc52cf40a5f8c0431301e4788d972dd19ddf9b245cb76789ce
|
|
| MD5 |
e69961df56bc75cf9ad19555233d5462
|
|
| BLAKE2b-256 |
12520d27ac1174719b942e16c0dc0e16aee1b8350d6971faf61520145fc04f51
|
