akdh/cst-tools

Tools for the Contextual Suggestion Track.

Render Files

In order to render the HTML view that assessors will see run:

python render.py response.json

Where response.json is valid response from a suggestions request. pystache must be installed for this script to run:

pip install pystache

Other tools:

These two Gists might also be helpful:

https://gist.github.com/akdh/65c6391eb85b553fcf12

https://gist.github.com/akdh/564cbb5f9c6c92c99d8a

cst-tools's Issues

Suggestions not rendered

Hi,
it's not possible to render the suggestions with the current version of the "render.py" script. Following code contains the necessary fixes. All fixes are commented.

import pystache, csv, json, sqlite3, sys

if len(sys.argv) != 2:
    print('usage: %s SUGGESTIONS')
    exit()

suggestions_filename = sys.argv[1]

with open('tags.csv') as f:
    reader = csv.reader(f)
    tags = [row[1].decode('utf-8') for row in reader] # Fix: The "pystache" module requires input in Unicode, but the "csv" module returns strings.

with open(suggestions_filename) as f:
    data = json.loads(f.read())

conn = sqlite3.connect('docs.db')
conn.row_factory = sqlite3.Row
cur = conn.cursor()

rows = []
for index in range(len(data['suggestions'])):
    id = data['suggestions'][index]
    cur.execute('select id, title, url, description from docs where id = ?', (id, ))
    row = dict(cur.fetchone())
    row['index'] = index
    rows.append(row) # Fix: Typo.

conn.close()

with open('templates/suggestions.html') as f:
    print (pystache.render(f.read(), {'tags': tags, 'raw_tags': json.dumps(tags), 'documents': rows})).encode('utf-8') # Fix: Necessary if you want to use shell redirection.

I'm using Python 2.7.9.

Database error

After modifying the suggestion file to satisfy the format which this tool is expecting, I receive this error:

Traceback (most recent call last):
File "render.py", line 26, in
cur.execute('select id, title, url, description from docs where id = ?', (id, ))
sqlite3.OperationalError: no such table: docs

(The line number is different because I added some sample codes to resolve the issue myself)