From: Martin Belanger <martin.belanger@dell.com>
Date: Fri, 16 Jul 2021 13:08:31 +0000 (-0400)
Subject: add README file for python bindings
X-Git-Tag: v1.0-rc0~116^2~2
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=667cfbd42e987adaba6bce9bc9a6c7f111b0aa9e;p=users%2Fsagi%2Flibnvme.git

add README file for python bindings
---

diff --git a/pynvme/README.md b/pynvme/README.md
new file mode 100644
index 00000000..ac51b387
--- /dev/null
+++ b/pynvme/README.md
@@ -0,0 +1,32 @@
+# Python bindings for libnvme
+
+We use [SWIG](http://www.swig.org/) to generate Python bindings for libnvme.
+
+## How to use
+
+```python
+import sys
+from libnvme import nvme
+
+root = nvme.root()     # This is a singleton
+host = nvme.host(root) # This "may be" a singleton. 
+ctrl = nvme.ctrl(subsysnqn=<nqn>, transport=<trtype>, traddr=<traddr>, trsvcid=<trsvcid>, host_traddr=<traddr or None>, host_iface=<iface or None>)
+
+try:
+    ctrl.connect(host)
+    print(f"connected to {ctrl.name} subsys {ctrl.subsystem.name}")
+except Exception as e:
+	sys.exit(f'Failed to connect: {e}')
+
+try:
+	log_pages = ctrl.discover()
+	print(pprint.pformat(log_pages))
+except Exception as e:
+	sys.exit(f'Failed to retrieve log pages: {e}')
+
+try:
+	ctrl.disconnect()
+except Exception as e:
+	sys.exit(f'Failed to disconnect: {e}')
+```
+