summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2014-09-08 19:43:38 -0500
committerKali Kaneko <kali@leap.se>2014-09-08 19:47:04 -0500
commitd70705823bd6ce90d2e3849438c384978672cbb5 (patch)
treed538adaaecc1f6dca17c18e762be60781591f999 /README.rst
parenta181dc3bd83cee6ce1d8082f66d87b7e96b8a3bd (diff)
add usage section
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 2e62553..5cc37a4 100644
--- a/README.rst
+++ b/README.rst
@@ -9,3 +9,21 @@ Packaging for SQLCipher (c) 2013 Kali Kaneko
It uses a sqlcipher amalgamation, see https://www.sqlite.org/amalgamation.html
+Usage
+-----
+You have to pass the ``PRAGMA=key`` before doing any operations::
+ from pysqlcipher import dbapi2 as sqlite
+ conn = sqlite.connect('test.db')
+ c = conn.cursor()
+ c.execute("PRAGMA key='test'")
+ c.execute('''create table stocks (date text, trans text, symbol text, qty real, price real)''')
+ c.execute("""insert into stocks values ('2006-01-05','BUY','RHAT',100,35.14)""")
+ conn.commit()
+ c.close()
+
+You can quickly verify that your database file in indeed encrypted::
+ hexdump -C test.db
+ ab 7f 61 7a 33 9d 07 f4 08 68 c9 b0 4f e3 34 60 |..az3....h..O.4`|
+ bb 9d 9c 3d 9e ce 69 57 b6 2f 36 c4 fd 13 bd 61 |...=..iW./6....a|
+ 77 bf e3 1d 65 b5 ea f7 d2 fc 98 31 23 66 a0 1e |w...e......1#f..|
+ a4 4f fa 66 49 36 84 a1 3e 0c 21 98 84 07 eb 07 |.O.fI6..>.!.....|