libbbf 0.2.4__cp312-cp312-win32.whl → 0.2.13__cp312-cp312-win32.whl

{libbbf-0.2.4.dist-info → libbbf-0.2.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: libbbf
-Version: 0.2.4
+Version: 0.2.13
 Summary: Bound Book Format (BBF) tools and bindings
 Home-page: https://github.com/ef1500/libbbf
 Author: EF1500
@@ -23,7 +23,7 @@ Dynamic: summary
 
 ## Project Overview
 
-`libbbf-python` provides Python bindings and command-line tools for the Bound Book Format (BBF). The Bound Book Format is an archive format designed for digital books and comics. This package allows Python developers to programmatically create and read `.bbf` files, and provides convenient command-line utilities to convert between common archive formats (like CBZ/CBX) and BBF.
+`libbbf-python` provides Python bindings and command-line tools for the [Bound Book Format (BBF)](https://github.com/ef1500/libbbf). The Bound Book Format is an archive format designed for digital books and comics. This package allows Python developers to programmatically create and read `.bbf` files, and provides convenient command-line utilities to convert between common archive formats (like CBZ/CBX) and BBF.
 
 The core of `libbbf-python` is a `pybind11` wrapper around the high-performance C++ `libbbf` library, ensuring speed and native integration.
 
@@ -53,7 +53,8 @@ Once installed, two command-line tools will be available globally: `cbx2bbf` and
 ### `cbx2bbf`: Create BBF Files from CBZ/Images
 
 **Usage:**
-```cbx2bbf <inputs...> [options] --output <output.bbf>
+```
+cbx2bbf <inputs...> [options] --output <output.bbf>
 ```
 
 **Inputs:**
@@ -132,6 +133,60 @@ bbf2cbx <input.bbf> [options] --output <output.cbz_or_dir>
     bbf2cbx series.bbf --info
     ```
 
+## Using `libbbf`
+
+You can also interface libbbf directly from python.
+
+Example 1: Creating a .bbf file
+```python
+from libbbf import BBFBuilder
+import os
+
+# Create a new Bound Book
+builder = BBFBuilder("my_comic.bbf")
+
+# Add Metadata
+builder.add_metadata("Title", "Solo Leveling")
+builder.add_metadata("Author", "Chugong")
+
+# Add Pages (Assets are automatically deduplicated by hash!)
+page_files = sorted(os.listdir("./chapter_images"))
+for i, filename in enumerate(page_files):
+    full_path = os.path.join("./chapter_images", filename)
+    
+    # Flags: 0 = Standard
+    builder.add_page(full_path, type=1, flags=0) 
+
+    # Define a Chapter every 20 pages
+    if i % 20 == 0:
+        builder.add_section(f"Chapter {i // 20 + 1}", start_page=i)
+
+# Finalize writes the footer and optimized tables
+builder.finalize()
+print("BBF created successfully.")
+```
+
+Example 2: Verifying a .bbf file
+```python
+import libbbf
+import time
+
+reader = libbbf.BBFReader("massive_archive.bbf")
+
+print("Verifying file integrity...")
+start = time.time()
+
+# This releases the GIL, so it's thread-safe and incredibly fast
+is_valid = reader.verify()
+
+end = time.time()
+
+if is_valid:
+    print(f"SUCCESS: Integrity verified in {end - start:.4f}s")
+else:
+    print("ERROR: Corruption detected!")
+```
+
 ## Contributing
 
 Contributions, issues, and feature requests are welcome! For libbbf, free to check the [issues page](https://github.com/ef1500/libbbf/issues) (or create one if it doesn't exist yet).

libbbf-0.2.13.dist-info/RECORD

@@ -0,0 +1,9 @@
+libbbf.cp312-win32.pyd,sha256=64db_SpECd3TJAMLbZCVN29vdRg4AQTKSL66AtXWIEY,246272
+libbbf_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+libbbf_tools/bbf2cbx.py,sha256=HbPmcVOUSTgVnkPpXEJCTRYesIhcYnn0rA91oGC9XKI,4314
+libbbf_tools/cbx2bbf.py,sha256=n9qsPojUqnm_2yFyBWB4q5_4J71_lZjVdz9L8LIYLTQ,8107
+libbbf-0.2.13.dist-info/METADATA,sha256=3Hv-VSbobLJtJbjTUZXsDYvDN54dbc_3NUUJHwcZ4b4,7491
+libbbf-0.2.13.dist-info/WHEEL,sha256=3-JGBxlfJ7cpG1EEEM2PrRJYpl2Lix3zyWKiPlGiWWY,97
+libbbf-0.2.13.dist-info/entry_points.txt,sha256=7qX-_x7iM2ygeZmkpL_bLEuJY1TlifTetaprHlK39hA,90
+libbbf-0.2.13.dist-info/top_level.txt,sha256=DM4mwVaAZp8aBb8KOwCvyYCev1_RMhsj3lXjBWDnbJc,20
+libbbf-0.2.13.dist-info/RECORD,,

libbbf-0.2.4.dist-info/RECORD

@@ -1,9 +0,0 @@
-libbbf.cp312-win32.pyd,sha256=NMLCloFzmYQc4OkOJtHVBjlBOJ2p5gX6fZo_-T6iP0M,240640
-libbbf_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-libbbf_tools/bbf2cbx.py,sha256=HbPmcVOUSTgVnkPpXEJCTRYesIhcYnn0rA91oGC9XKI,4314
-libbbf_tools/cbx2bbf.py,sha256=n9qsPojUqnm_2yFyBWB4q5_4J71_lZjVdz9L8LIYLTQ,8107
-libbbf-0.2.4.dist-info/METADATA,sha256=WBPIrNkDde5UEM3JEJ8uWA-0TYRIrH8Fcfa5Re8NDR4,6123
-libbbf-0.2.4.dist-info/WHEEL,sha256=3-JGBxlfJ7cpG1EEEM2PrRJYpl2Lix3zyWKiPlGiWWY,97
-libbbf-0.2.4.dist-info/entry_points.txt,sha256=7qX-_x7iM2ygeZmkpL_bLEuJY1TlifTetaprHlK39hA,90
-libbbf-0.2.4.dist-info/top_level.txt,sha256=DM4mwVaAZp8aBb8KOwCvyYCev1_RMhsj3lXjBWDnbJc,20
-libbbf-0.2.4.dist-info/RECORD,,