scruby-plugin 0.2.3__py3-none-any.whl

scruby_plugin/__init__.py

@@ -0,0 +1,17 @@
+# Copyright (c) 2026 Gennady Kostyunin
+# SPDX-License-Identifier: MIT
+"""Scruby-Plugin - Library for creating Scruby plugins."""
+
+from __future__ import annotations
+
+__all__ = ("ScrubyPlugin",)
+
+import weakref
+from typing import Any
+
+
+class ScrubyPlugin:  # noqa: RUF067
+    """Base class for creating Scruby plugins."""
+
+    def __init__(self, scruby: Any) -> None:  # noqa: D107
+        self.scruby = weakref.ref(scruby)

scruby_plugin-0.2.3.dist-info/METADATA

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: scruby-plugin
+Version: 0.2.3
+Summary: Library for creating Scruby plugins.
+Keywords: scruby,plugin,database
+Author: kebasyaty
+Author-email: kebasyaty <kebasyaty@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12, <4.0
+Project-URL: Bug Tracker, https://github.com/kebasyaty/scruby-plugin/issues
+Project-URL: Changelog, https://github.com/kebasyaty/scruby-plugin/blob/v0/CHANGELOG.md
+Project-URL: Homepage, https://github.com/kebasyaty/scruby-plugin
+Project-URL: Repository, https://github.com/kebasyaty/scruby-plugin
+Project-URL: Source, https://github.com/kebasyaty/scruby-plugin
+Description-Content-Type: text/markdown
+
+# scruby-plugin
+
+Library for creating Scruby plugins.
+
+<br>
+<br>
+
+<p>
+    <a href="https://github.com/kebasyaty/scruby-plugin/actions/workflows/test.yml" alt="Build Status"><img src="https://github.com/kebasyaty/scruby-plugin/actions/workflows/test.yml/badge.svg" alt="Build Status"></a>
+    <a href="https://pypi.python.org/pypi/scruby-plugin/" alt="PyPI pyversions"><img src="https://img.shields.io/pypi/pyversions/scruby-plugin.svg" alt="PyPI pyversions"></a>
+    <a href="https://pypi.python.org/pypi/scruby-plugin/" alt="PyPI status"><img src="https://img.shields.io/pypi/status/scruby-plugin.svg" alt="PyPI status"></a>
+    <a href="https://pypi.python.org/pypi/scruby-plugin/" alt="PyPI version fury.io"><img src="https://badge.fury.io/py/scruby-plugin.svg" alt="PyPI version fury.io"></a>
+    <br>
+    <a href="https://pyrefly.org/" alt="Types: Pyrefly"><img src="https://img.shields.io/badge/types-Pyrefly-FFB74D.svg" alt="Types: Pyrefly"></a>
+    <a href="https://docs.astral.sh/ruff/" alt="Code style: Ruff"><img src="https://img.shields.io/badge/code%20style-Ruff-FDD835.svg" alt="Code style: Ruff"></a>
+    <a href="https://pypi.org/project/scruby-plugin"><img src="https://img.shields.io/pypi/format/scruby-plugin" alt="Format"></a>
+    <a href="https://pepy.tech/projects/scruby-plugin"><img src="https://static.pepy.tech/badge/scruby-plugin" alt="PyPI Downloads"></a>
+    <a href="https://github.com/kebasyaty/scruby-plugin/blob/main/LICENSE" alt="GitHub license"><img src="https://img.shields.io/github/license/kebasyaty/scruby-plugin" alt="GitHub license"></a>
+</p>
+
+<br>
+
+## Requirements
+
+[View the list of requirements](https://github.com/kebasyaty/scruby-plugin/blob/v0/REQUIREMENTS.md "Requirements").
+
+## Installation
+
+```shell
+uv add scruby-plugin
+```
+
+## Usage
+
+```python
+from typing import Any
+from scruby_plugin import ScrubyPlugin
+
+class PluginName(ScrubyPlugin):
+    def __init__(self, scruby: Any) -> None:
+        ScrubyPlugin.__init__(self, scruby)
+
+    ...your code...
+```
+
+## Example
+
+```python
+import anyio
+from typing import Any
+from pydantic import Field
+from scruby import Scruby, ScrubyModel, settings
+from scruby_plugin import ScrubyPlugin
+from pprint import pprint as pp
+
+
+# Create plugin
+class CollectionMeta(ScrubyPlugin):
+    def __init__(self, scruby: Any) -> None:
+        ScrubyPlugin.__init__(self, scruby)
+
+    async def get(self) -> Any:
+        scruby = self.scruby()
+        return await scruby.get_meta()
+
+
+# Plugins connection.
+settings.PLUGINS = [
+    CollectionMeta,
+]
+
+
+class Car(ScrubyModel):
+    """Car model."""
+
+    brand: str = Field(strict=True, frozen=True)
+    model: str = Field(strict=True, frozen=True)
+    year: int = Field(strict=True)
+    power_reserve: int = Field(strict=True)
+    # key is always at bottom
+    key: str = Field(
+        strict=True,
+        frozen=True,
+        default_factory=lambda data: f"{data['brand']}:{data['model']}",
+    )
+
+
+async def main() -> None:
+    # Get collection `Car`.
+    car_coll = await Scruby.collection(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)
+```
+
+## Changelog
+
+[View the change history](https://github.com/kebasyaty/scruby-plugin/blob/v0/CHANGELOG.md "Changelog").
+
+## License
+
+This project is licensed under the [MIT](https://github.com/kebasyaty/scruby-plugin/blob/main/LICENSE "MIT").

scruby_plugin-0.2.3.dist-info/RECORD

@@ -0,0 +1,6 @@
+scruby_plugin/__init__.py,sha256=LQGjuPOGApeKRrISomnqXLPhDzqO5Qoi5TWAL0ND1nU,423
+scruby_plugin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby_plugin-0.2.3.dist-info/licenses/LICENSE,sha256=mvh5qv1YJGyuVCkRxonDDNOzxlwXszKvwxXfOeXKrqw,1074
+scruby_plugin-0.2.3.dist-info/WHEEL,sha256=eycQt0QpYmJMLKpE3X9iDk8R04v2ZF0x82ogq-zP6bQ,79
+scruby_plugin-0.2.3.dist-info/METADATA,sha256=ewqLWgI3rfT21iwP-u1xgB3dDAwU-qANxXr3NkfsCXA,5025
+scruby_plugin-0.2.3.dist-info/RECORD,,

scruby_plugin-0.2.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.24
+Root-Is-Purelib: true
+Tag: py3-none-any

scruby_plugin-0.2.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gennady Kostyunin
+
+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.