dbs / refdeskstats Goto Github PK

View Code? Open in Web Editor NEW

2.0 3.0 1.0 101 KB

Collect daily reference desk statistics in a database

License: GNU General Public License v3.0

Python 59.38% HTML 39.98% CSS 0.64%

refdeskstats's Introduction

Installation

Description

This is an application allowing the collection of reference desk statistics through a web application with Flask.

Requirements

This application requires:

Flask
- Flask-Babel
- Flask-Login
Python-LDAP

Simply pip-install them and you’ll be on your way out.

Database

The database used is PostgreSQL. The file schema.sql will have all of the SQL needed to generate the tables/permissions/views that the application demands.

Babel Install

Language translations for french are already included with the application, and should work out of the box. In the case they don’t:

pybabel compile -i messages.pot -d translations/

should be enough to fix it.

Secret Key

You’ll need to generate your own secret key to sign cookies. Generally, the easiest way to do this would be:

>>> import os
>>> os.urandom(24).encode('hex')

Which will give you a nice, long sequence of hex digits.

refdeskstats's People

Contributors

Stargazers

Watchers

Forkers

vtrlx

refdeskstats's Issues

Support translations

We should support French and English interfaces for this form. @victory000 ?

Add authentication for data submission / editing pages

Right now anyone with the URL can submit / edit data, which isn't so great.

Consider the use of Flask-Login (https://pypi.python.org/pypi/Flask-Login) for a base level of authentication on the submission pages, with a session time of something like 4 hours. Then we can add in one more column to the refdesktstats table to keep track of who entered the data.

Flask-Login requires an authentication method; for testing purposes, you could start with a hardcoded username / password. Then when you have that working, add in something like Flask-ldap (http://flask-ldap.readthedocs.org/ -- but no MongoDB!) so that we can authenticate against Laurentian's LDAP server.

LU's LDAP auth attributes are as follows:

LDAP Host: 142.51.1.221
LDAP Port: 389
LDAP Domain: laurentian.ca
LDAP Base DN: OU=Empl,o=LUL
LDAP Profile Key: cn

(note: for testing purposes, you might need to swap "Empl" for "STD" to enable authenticating against student accounts)

Need an installation document that includes steps such as compiling translations

We ship the raw translation of messages.po but at install time need to compile it first with:

pybabel compile -d translations

... and then of course copy it into place.

schema.sql does not have complete permissions, references wrong table

Starting with a fresh database, one can see that the views at times reference the 'reftstats' table instead of the 'refdeskstats' table.

Also, assuming that one creates the database and schema as a superuser and wants a limited privilege user to only be able to query the views, then we need some GRANT SELECT statements for our target limited privilege user.

Verbose mode should default to 'false'

It's great to have debugging statements in the code, but not so great to have them running by default. Ideally you only enable verbose mode when you run into a problem, so it should be off by default.

babel.cfg is missing from the git tree

Without babel.cfg, the application will not run successfully.

Make phone column float to the right of the page, if we have space

Right now there's a lot of vertical scrolling required if someone wants to hit the submit button with the mouse, and on a widescreen the "Phone" column may effectively be hidden. It would be great to float it to the right so that on widescreens at the right resolution all of the columns will appear on one horzontal plane.