David Blume commited on 2016-09-14 07:22:02
Showing 1 changed files, with 10 additions and 5 deletions.
... | ... |
@@ -5,7 +5,8 @@ It is written in Python and yet harkens back to a simpler era before Redis and R |
5 | 5 |
|
6 | 6 |
## Dependencies and Guarantees |
7 | 7 |
|
8 |
-kvs uses a local file for its backing store. Its ACID properties are as follows: |
|
8 |
+kvs uses a local file for its backing store, and stores the data in the human-friendly |
|
9 |
+[YAML](http://yaml.org/) format. Its ACID properties are as follows: |
|
9 | 10 |
|
10 | 11 |
* **Atomicity**: Either all tuples in a transaction are successfully saved or none are. |
11 | 12 |
* **Consistency**: Only valid states are saved, and saves are atomic. |
... | ... |
@@ -25,18 +26,22 @@ If you're me, and you want to contribute to the repo, then you can clone it like |
25 | 26 |
|
26 | 27 |
# Building it |
27 | 28 |
|
28 |
-1. Enable Python pages at your web server. See [How to use Python in the web](https://docs.python.org/2/howto/webservers.html#). My configuration is for Apache, hence the .htaccess file. |
|
29 |
-2. Move auth\_sample.txt to auth.txt, and replace `yourauthorizationhere` with a passcode you choose. chmod 600 the file or deny access to it via .htaccess. |
|
29 |
+1. Enable Python pages at your web server. See [How to use Python in the web](https://docs.python.org/2/howto/webservers.html#). |
|
30 |
+ My configuration is for Apache, hence the .htaccess file. |
|
31 |
+2. Move auth\_sample.txt to auth.txt, and replace `yourauthorizationhere` with a passcode you choose. |
|
32 |
+ chmod 600 the file or deny access to it via .htaccess. |
|
30 | 33 |
3. Optional: Use secure HTTP. I recommend getting a free SSL certificate from [Let's Encrypt](https://letsencrypt.org/). |
31 | 34 |
4. If you don't have the YAML module, pip install pyyaml. |
32 | 35 |
|
33 | 36 |
# Using it |
34 | 37 |
|
35 |
-Here is [a live instance that serves an index page](https://kvs.dlma.com/). You can send a key to get a value like so: |
|
38 |
+Here is [a live instance that serves an index page](https://kvs.dlma.com/). |
|
39 |
+You can send a key to get a value like so: |
|
36 | 40 |
|
37 | 41 |
https://kvs.dlma.com/?k=1GM35N000010 |
38 | 42 |
|
39 |
-Special use case, here's how to get the value for the most-recently updated key of a list of keys. The list could contain any number of keys, but only one value will be returned. |
|
43 |
+Special use case, here's how to get the value for the most-recently updated key of a |
|
44 |
+list of keys. The list could contain any number of keys, but only one value will be returned. |
|
40 | 45 |
|
41 | 46 |
https://kvs.dlma.com/?k=1GM35N000010,1GU44N010910 |
42 | 47 |
|
43 | 48 |