docs

Author: bitplane

.vscode/extensions.json

@@ -3,6 +3,6 @@
 		"ms-python.python",
 		"davidanson.vscode-markdownlint",
 		"ms-vscode.makefile-tools",
-		"charliermarsh.ruff"          // Ruff VS-Code extension
+		"charliermarsh.ruff"
 	]
 }

.vscode/settings.json

@@ -1,13 +1,17 @@
 {
     "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
     "python.envFile": "${workspaceFolder}/.env",
+    "flake8.enabled": false,
     "ruff.lint.enable": true,
     "ruff.organizeImports": true,
     "ruff.fixAll": true,
+    "ruff.lineLength": 120,
     "python.testing.pytestEnabled": true,
     "python.testing.unittestEnabled": false,
     "python.analysis.extraPaths": ["${workspaceFolder}/src"],
     "[python]": {
-        "editor.defaultFormatter": "charliermarsh.ruff"
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.formatOnSave": true,
+        "editor.formatOnPaste": false
     }
 }

README.md

@@ -1,14 +1,14 @@
 # 🧊 blkcache
 
-Userspace transparent block device cache
+Userspace transparent block device cache.
 
-## Deps
+## ⬇️ Deps
 
 ```
 sudo apt install libndb-bin nbdkit-plugin-python nbdfuse fuse3
 ```
 
-## Usage
+## ℹ️ Usage
 
 ```
 uvx blkcache /dev/sr0 file.iso
@@ -18,10 +18,24 @@ Then point tools at `file.iso` instead of `/dev/sr0`.
 
 ## Why?
 
-Copying some CDs and needed a way to do `7z /dev/sr0` to dump the filesystem,
-and then `ddrescue /dev/sr0` to get the image if possible. This means it
-doesn't have to read the disk twice
+Copying some CDs and needed a way to do mount in FUSE, dump the filesystem, and
+then `ddrescue /dev/sr0` to get the image if possible. This means it doesn't
+read the disk twice, even if you have a ton of drives attached
 
 ## How?
 
-mind your own fucking business
+It uses `nbdkit` to create a Network Block Storage device in Python, mounts it
+using `fuse`, then creates a mmapped disk cache of sectors as they're read.
+
+## 🔗 Links
+
+* [🏠 home](https://bitplane.net/dev/python/blkcache)
+* [🐱 github](https://github.com/bitplane/blkcache)
+* [🐍 pypi](https://pypi.org/project/blkcache)
+* [📖 pydoc](https://bitplane.net/dev/python/blkcache/pydoc)
+
+## 🌍 Related
+
+* [🪦 rip](https://github.com/bitplane/rip)
+* [🕷️ scrapers](https://bitplane.net/python/scrapers)
+