scruby 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

{scruby-0.1.0.dist-info → scruby-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.1.0
+Version: 0.1.2
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -62,11 +62,11 @@ Description-Content-Type: text/markdown
       <a href="https://github.com/kebasyaty/scruby/releases/" alt="GitHub release"><img src="https://img.shields.io/github/release/kebasyaty/scruby" alt="GitHub release"></a>
     </p>
     <p align="center">
-      **Scruby** is a fast key-value storage library that provides an ordered mapping from string keys to string values.
+      Scruby is a fast key-value storage library that provides an ordered mapping from string keys to string values.
       <br>
       The library uses fractal-tree addressing.
       <br>
-      The maximum size of the database is 16^32=340282366920938463463374607431768211456 branches,
+      The maximum size of the database is 16**32=340282366920938463463374607431768211456 branches,
       each branch can store one or more keys.
       <br>
       The value of any key can be obtained in 32 steps, thereby achieving high performance.
@@ -76,15 +76,6 @@ Description-Content-Type: text/markdown
   </p>
 </div>
 
-##
-
-<p>
-  <a href="https://github.com/kebasyaty/scruby" alt="Project Status">
-    <img src="https://raw.githubusercontent.com/kebasyaty/scruby/v0/assets/project_status/project-status-pre-alpha.svg"
-      alt="Project Status">
-  </a>
-</p>
-
 ## Documentation
 
 Online browsable documentation is available at [https://kebasyaty.github.io/scruby/](https://kebasyaty.github.io/scruby/ "Documentation").
@@ -101,10 +92,29 @@ uv add scruby
 
 ## Usage
 
-[It is recommended to look at examples here](https://github.com/kebasyaty/scruby/tree/main/examples "Examples").
-
 ```python
-import scruby
+import anyio
+from scruby import Scruby
+
+
+async def main() -> None:
+    """Example."""
+
+    db = Scruby()
+    await db.set_key("key name", "Some text")
+    await db.get_key("key name")  # => "Some text"
+    await db.get_key("key missing")  # => KeyError
+    await db.has_key("key name")  # => True
+    await db.has_key("key missing")  # => False
+    await db.delete_key("key name")
+    await db.delete_key("key missing")  # => KeyError
+    # Full database deletion.
+    await db.napalm()
+    await db.napalm()  # => FileNotFoundError
+
+
+if __name__ == "__main__":
+    anyio.run(main)
 ```
 
 ## Changelog

scruby-0.1.2.dist-info/RECORD

@@ -0,0 +1,6 @@
+scruby/__init__.py,sha256=5_WsWLxxGQ8LYi0XrZc7S5P3HmaP1wfvb9VUdrVxvmM,6694
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.1.2.dist-info/METADATA,sha256=eBxfCwrZ2OrBN4M2npu95MV0K8JSmzbMvgUhz1z2vI0,5906
+scruby-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.1.2.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.1.2.dist-info/RECORD,,

scruby-0.1.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-scruby/__init__.py,sha256=5_WsWLxxGQ8LYi0XrZc7S5P3HmaP1wfvb9VUdrVxvmM,6694
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.1.0.dist-info/METADATA,sha256=e0KkEerqyZngnSbMbXpV4BYcdz7gpye_m3alBOmIq4E,5694
-scruby-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.1.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.1.0.dist-info/RECORD,,